Docs
REST API v1

Webhook endpoint

Fields returned by the REST API for webhook endpoint.

Fields

FieldTypeMeaning
idstringResource identifier.
projectIdstringOwning project.
environmentIdstringOwning environment.
urlstringReceiver URL.
eventTypesarraySubscribed event names.
statusstringLifecycle or delivery state.
signingSecretVersionnumberCurrent signing secret version.
signingSecretRotatedAtstringLatest secret rotation timestamp.
createdAtstringCreation timestamp.
updatedAtstringLatest update timestamp.

Example

JSON
{
  "id": "webhook_example",
  "projectId": "project_example",
  "environmentId": "environment_example",
  "url": "https://your-app.example/webhooks/relayrtc",
  "eventTypes": [
    "room.ended"
  ],
  "status": "enabled",
  "signingSecretVersion": 1,
  "signingSecretRotatedAt": "2026-01-01T12:00:00.000Z",
  "createdAt": "2026-01-01T12:00:00.000Z",
  "updatedAt": "2026-01-01T12:00:00.000Z"
}

Signing secret

Creation and rotation return these fields plus signingSecret and rotationPolicy: 'immediate replacement'. Reads do not reveal the secret.