Webhook Endpoints

You can configure webhook endpoints via the API to be notified about events that happen in your Frame account.

Most users configure webhooks from the dashboard, which provides a user interface for registering your webhook endpoints.

Related guide: Setting up webhooks

The Webhook Endpoint object

Attributes
idstring

Unique identifier for the object.

descriptionnullable string

An optional description of what the webhook is used for.

event_codesarray of strings

The list of events to enable for this endpoint.

secretstring

The endpoint's secret, used to generate webhook signatures. Only returned at creation.

statusstring

The status of the webhook. It can be active or disabled.

urlstring

The URL of the webhook endpoint.

livemodeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

objectstring

String representing the object's type. Objects of the same type share the same value.

createdtimestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

updatedtimestamp

Time at which the object was last updated. Measured in seconds since the Unix epoch.

THE CUSTOMER OBJECT
{
  "id": "404f86c1-3dc9-46ca-a4b1-505daf00bf2e",
  "description": "",
  "livemode": false,
  "event_codes": [
    "customer.subscription.created",
    "customer.subscription.updated",
    "customer.subscription.incomplete"
  ],
  "secret": "XHuQxCf5Fo7QwARjScwryWUfWKEbs3Ry",
  "status": "active",
  "url": "https://example.com/webhook/endpoint",
  "object": "webhook_endpoint",
  "created": 1739161393,
  "updated": 1739161393
}