Events

4 operations under events. Examples read $API and $KEY from your shell.

GET /v1/events
GET /v1/events/{id}
POST /v1/events/{id}/redeliver
GET /v1/events/{id}/deliveries

`GET /v1/events`

Parameters

limit integer optional in query
starting_after string optional in query
ending_before string optional in query
type string optional in query

Responses

200 Default Response

object

data array required
Each item:
- id string required
- type string required
- created string required
- data object required
  - object object required
has_more boolean required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/events" \
  -H "authorization: Bearer $KEY"

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/events");

`GET /v1/events/{id}`

Parameters

id string required in path

Responses

200 Default Response

object

id string required
type string required
created string required
data object required
- object object required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/events/$ID" \
  -H "authorization: Bearer $KEY"

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/events/{id}", {
  params: { path: { id: "<id>" } },
});

`POST /v1/events/{id}/redeliver`

Send an Idempotency-Key header on every POST so a retry never repeats the request.

Parameters

id string required in path

Request body

application/json, required

object

Responses

202 Default Response

object

id string required
status string required one of queued

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  -X POST \
  "$API/v1/events/$ID/redeliver" \
  -H "authorization: Bearer $KEY" \
  -H "idempotency-key: $(uuidgen)" \
  -H "content-type: application/json" \
  -d '{}'

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key and an Idempotency-Key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.POST("/v1/events/{id}/redeliver", {
  params: { path: { id: "<id>" } },
  body: {},
});

`GET /v1/events/{id}/deliveries`

Parameters

limit integer required in query
starting_after string optional in query
id string required in path

Responses

200 Default Response

object

data array required
Each item:
- id string required
- endpoint_id string required
- event_id string required
- event_type string required
- kind string required one of event, redelivery
- status string required one of pending, succeeded, failed, canceled
- attempts integer required
- max_attempts integer required
- first_attempt_at string required (nullable)
- last_attempt_at string required (nullable)
- last_status_code integer required (nullable)
- last_error string required (nullable)
- next_attempt_at string required (nullable)
- created_at string required
- updated_at string required
has_more boolean required

Errors are RFC 9457 problem documents (application/problem+json).

curl

curl -s \
  "$API/v1/events/$ID/deliveries?limit=1" \
  -H "authorization: Bearer $KEY"

SDK

import { createScrClient } from "@scr/sdk";

// The client sends the API key for you.
const client = createScrClient({ baseUrl: process.env.API!, apiKey: process.env.KEY! });
const { data, error } = await client.GET("/v1/events/{id}/deliveries", {
  params: { path: { id: "<id>" }, query: { limit: 1 } },
});

Edit on GitHub