Update webhook​

PATCH
/webhooks/{webhookId}

Updates one or more webhook delivery settings: target URL, shared secret, or subscribed event types. At least one field must be supplied; the enabled state is not changed by this endpoint.

Use cases

  • Rotate the shared secret.
  • Move deliveries to a new HTTPS receiver or change event subscriptions.

Related endpoints

  • GET /webhooks/{webhookId} — read the current safe configuration.
  • GET /webhooks — list configured destinations.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

webhookId*

ID returned by POST /webhooks. Use it to retrieve, update, or delete the destination.

Type
string
Required
Example"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Max Length
36
Format
"uuid"
Pattern
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Request Body​

application/json

New HTTPS endpoint for event deliveries.

Max Length256
Format"uri"

New shared secret; update the receiver to use it because it is not returned by GET or list responses.

Min Length8
Max Length40

Replace the subscribed event types; duplicate values are rejected.

Min Items1

Responses​

success.webhook.update

application/json

Playground​

Authorization
Headers
Variables
Key
Value
Body

Samples​