List webhook events

GET

/api/webhooks/events

const url = 'https://reignitor.com/api/webhooks/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reignitor.com/api/webhooks/events \
  --header 'Authorization: Bearer <token>'

Returns the event names you can subscribe to, and how deliveries are signed.

Authorizations

apiKey

Responses

200

Event names and the signature scheme.

application/json

object

events

required

Array<string>

Allowed values: user.signup user.onboarded subscription.created subscription.canceled video.completed video.failed credits.low credits.purchased

signature

required

object

header

string

scheme

string

replay_window_seconds

integer

Example

{
  "events": [
    "user.signup",
    "user.onboarded",
    "subscription.created",
    "subscription.canceled",
    "video.completed",
    "video.failed",
    "credits.low",
    "credits.purchased"
  ],
  "signature": {
    "header": "X-Reignitor-Signature",
    "scheme": "sha256=HMAC_SHA256(`${X-Reignitor-Timestamp}.${rawBody}`, secret)",
    "replay_window_seconds": 300
  }
}

401

The key is missing, malformed, unknown or revoked.

application/json

Every error has a human-readable error. Most also have a machine-readable code.

object

error

required

A message you can show to a person.

string

code

A stable code to branch on. Not every error has one.

string

details

Extra context for some codes, such as retryAfter or usage figures.

retryAfter

Seconds to wait before retrying. Present on some RATE_LIMITED errors.

integer

feature

string

plan

string

key

additional properties

any

Examples

No key, or not an emp_ key

{
  "error": "Unauthorized",
  "code": "NO_API_KEY"
}

Unknown or revoked key

{
  "error": "Invalid or revoked API key",
  "code": "INVALID_API_KEY"
}