Create or update a webhook destination
Registers a webhook destination for the API key's organization, identified by its URL: the first call creates it, later calls with the same URL update its events, name, description, API version and installation. The signing secret is generated on create, kept on update, and returned every time. A destination disabled in the dashboard stays disabled. Requires an API key with the WEBHOOKS_MANAGE permission.
Create or update a webhook destination › Request Body
urlEndpoint that receives the POST deliveries.
eventsEvent types to deliver.
nameDisplay name. Defaults to the URL's host when creating.
descriptionapiVersionCloud API version deliveries are shaped for and labelled with. Defaults to 2026-10-01 when creating; kept when updating.
installationIdInstallation that owns the destination. Defaults to the Dossiers-Installation-Id header.
Create or update a webhook destination › Responses
idnameurleventsapiVersioninstallationIdisActiveAn upsert never re-enables a destination disabled in the dashboard.
secretHMAC-SHA256 signing secret. Kept across updates.
createdTrue when this call created the destination.