Read Event

Intent

Reads the event without changing it.

When to call it

Call this after your application has received or stored the identifier for the event.

Access boundary

Authorize the request with a token that carries events:read or events:write.

Successful result

A successful request returns 200. The response schema below defines the body your integration receives.

Operational notes

Get an event by ID.

Scopes: events:read events:write

GET

events

{id}

Read Event

curl --request GET \
  --url https://api.getruba.com/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/events/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email": "customer@example.com",
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://example.com/avatar.png",
    "external_id": "usr_1337",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "external_customer_id": "<string>",
  "label": "<string>",
  "source": "system",
  "name": "meter.credited",
  "metadata": {
    "meter_id": "<string>",
    "units": 123,
    "rollover": true
  },
  "member_id": "<string>",
  "external_member_id": "<string>",
  "child_count": 0,
  "parent_id": "<string>"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

string<uuid4>

required

The event ID.

Response

Successful Response

An event created by Ruba when credits are added to a customer meter.

string<uuid4>

required

The stable identifier for this record.

timestamp

string<date-time>

required

The timestamp of the event.

organization_id

string<uuid4>

required

The ID of the organization owning the event.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

customer_id

string<uuid4> | null

required

ID of the customer in your Ruba organization associated with the event.

customer

CustomerIndividual · object

required

The customer associated with the event.

CustomerIndividual
CustomerTeam

Show child attributes

external_customer_id

string | null

required

ID of the customer in your system associated with the event.

label

string

required

Human readable label of the event type.

source

string

required

The source of the event. system events are created by Ruba. user events are the one you create through our ingestion API.

Allowed value: "system"

name

string

required

The name of the event.

Allowed value: "meter.credited"

metadata

MeterCreditedMetadata · object

required

Show child attributes

member_id

string<uuid4> | null

ID of the member within the customer's organization who performed the action inside B2B.

external_member_id

string | null

ID of the member in your system within the customer's organization who performed the action inside B2B.

child_count

integer

default:0

Number of direct child events linked to this event.

parent_id

string<uuid4> | null

The ID of the parent event.

Read Event

curl --request GET \
  --url https://api.getruba.com/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getruba.com/v1/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/events/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email": "customer@example.com",
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "https://example.com/avatar.png",
    "external_id": "usr_1337",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "external_customer_id": "<string>",
  "label": "<string>",
  "source": "system",
  "name": "meter.credited",
  "metadata": {
    "meter_id": "<string>",
    "units": 123,
    "rollover": true
  },
  "member_id": "<string>",
  "external_member_id": "<string>",
  "child_count": 0,
  "parent_id": "<string>"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Read Event

Intent

When to call it

Access boundary

Successful result

Operational notes

Authorizations

Path Parameters

Response