Skip to navigation
API ReferenceWebhooks

Update

Updates a webhook’s events, projects, or both. The endpoint URL cannot be changed; create a new webhook instead.

Requires an API key with workspace access, or an access token. An API key restricted to selected projects can only update a webhook whose current and new projects are all within its scope.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
The ID of the webhook to update.

Request

This endpoint expects an object.
eventslist of enumsOptional
Replaces the events sent to the endpoint.
Allowed values:
project_idslist of stringsOptional
Replaces the projects whose events are sent to the endpoint.

Response

Success response
successboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error