Skip to navigation
API ReferenceWebhooks

Create

Creates a webhook that sends the chosen events for the chosen projects to endpoint_url. The response includes the webhook’s signing secret.

Requires an API key with workspace access, or an access token. An API key restricted to selected projects can only use projects within its scope.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Request

This endpoint expects an object.
endpoint_urlstringRequired
The URL that receives the webhook's requests. Must be a publicly routable HTTPS URL without embedded credentials, and unique within the workspace. It cannot be changed later.
eventslist of enumsRequired
The events to send to the endpoint.
Allowed values:
project_idslist of stringsRequired
The projects whose events are sent to the endpoint.

Response

Webhook created
idstring
The webhook ID.
signing_secretstring

The secret used to sign the webhook’s requests. It can be fetched again from GET /webhooks/{id}/secret.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error