Sign in
Webhooks

Create Webhook

Register a new webhook for a given event type. Auth secrets are encrypted before storage. Limited to 10 webhooks per API key.

post/api/v2/webhooks

Request body

urlstring uri required
event_type'clientview_updated' | 'incremental_update' | 'series_updated' | 'document_added' required
  • clientview_updated - Clientview Updated
  • incremental_update - Incremental Update
  • series_updated - Series Updated
  • document_added - Document Added
is_testboolean required
header_namestring
prefixstring
auth_secretstring

Response

idinteger required
event_typestring required
activeboolean required
is_testboolean required
urlstring uri required
header_namestring required
prefixstring required
masked_auth_secretstring required
created_atstring date-time required

Changes