List webhooks

URL Expired

The URL for this request expired after 30 days.

Parameters

limit

• type: integer
• range: 1 to 100
• defaults to: 20
• description: This parameter lets you specify the amount of webhooks to return in your API call. The maximum amount of webhooks you can have returned to you via this parameter is 100.

offset

• type: integer
• range: ≥ 0
• defaults to: 0
• description: Used to page through the webhooks. Every call to this endpoint will return the next offset value. This value is used in the offset parameter of the next call to get the next page of webhooks.

deleted

• type: boolean
• defaults to: false
• description: If true, fetches deleted webhooks rather than active ones.

Response

Successful Response: 200 OK.

• type: object
• properties:
  • webhooks: array of objects
    • webhooks: object
      • createdAt: string
      • id: string
      • secret: string
      • status: string
      • lastUpdatedAt: string
      • url: url
  • nextOffset: integer

Bad Request Response: 400 Bad Request.

Default Response: default Unexpected Server error.

Example API Call

curl --request GET \
     --url 'https://api.synthesia.io/v2/webhooks?limit=20&offset=0&deleted=false' \
     --header 'accept: application/json'

Example JSON Response

{
  "webhooks": [
    {
      "id": "string",
      "secret": "string",
      "url": "string"
    }
  ],
  "nextOffset": 0
}