Skip to navigation

List webhooks

List all currently configured webhooks in your Synthesia account.

Authentication

Authorizationstring
API Key authentication via header

Query parameters

limitintegerOptional1-100Defaults to 20
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.
offsetintegerOptional>=0Defaults to 0
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.
deletedbooleanOptionalDefaults to false
If true, fetches deleted webhooks rather than active ones.

Response

OK.
webhookslist of objectsOptional
nextOffsetintegerOptional

Errors

400
Bad Request Error