Webhooks

Create a Webhook

Use the Create a webhook endpoint to create a new event subscription.

post/v2/webhooks

Request

Base URL
https://api.synthesia.io
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/synthesia/apis/synthesia-api/docs/v2/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

eventsstring[] required

The webhook events for which notifications should be sent.

urlstring url required

The URL to send notifications to

Response

Webhook successfully created.

createdAtunknown

idstring

secretstring

statusunknown

lastUpdatedAtunknown

urlstring url

Changes

No recorded changes to this operation across all 1 revision of this API.