v1

latestOpenAPI 3.0.02026-07-14201133.2 KB

Webhooks

List web hooks

get/self/webhooks

Response

Successful

accountIdstring

Unique identifier of the account

createdAtstring

Created time for the webhook

eventsstring[]

Subscribed events for the webhook

expireAtstring

Expiration time for the webhook

idstring

Unique identifier for the webhook

metadataPolicy'NONE' | 'HEADER' | 'BODY'

Metadata policy for the webhook

purgeAtstring

Scheduled purge time for the webhook

renewedAtstring

Last renewed time for the webhook

signingAlgo'HMAC_SHA256' | 'NONE'

Signing algorithm for the webhook

signingKeystring

Signing key for the webhook

status'ACTIVE' | 'PAUSED'

Status for the webhook

urlstring

Destination URL for events

userIdstring

Unique identifier of the user

Example response

[
  {
    "createdAt": "2019-01-01T00:00:00.000Z",
    "events": [
      "CALL"
    ],
    "expireAt": "2019-01-01T00:00:00.000Z",
    "metadataPolicy": "NONE",
    "purgeAt": "2019-01-01T00:00:00.000Z",
    "renewedAt": "2019-01-01T00:00:00.000Z",
    "signingAlgo": "HMAC_SHA256",
    "statistics": {
      "totalAttempts": 10,
      "totalFailures": 10,
      "totalSuccesses": 10
    },
    "status": "ACTIVE",
    "url": "https://www.example.com"
  }
]