Skip to main content
PUT
Update webhook
Updates webhook configuration. Allows updating URL, events, and active status.

Authentication

This endpoint requires authentication via Bearer token:
  • Authorization: Bearer <token>

Path Parameters

Request Body

Updatable Fields

  • URL: Change webhook endpoint
  • Events: Update subscribed events
  • Active Status: Enable or disable webhook delivery
The environment of a webhook (production or sandbox) cannot be changed. Sending environment in an update returns 400 Bad Request. To receive events from the other environment, create a new webhook.

Permissions

Only OWNERS and ADMINS can update webhooks.

Example Request

Example Response

The response never includes the signing secret.

Common Errors

400 Bad Request

Invalid input data.

401 Unauthorized

Authentication required.

403 Forbidden

Only owners and admins can update webhooks.

404 Not Found

The webhook does not exist, or it belongs to another organization.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required
id
string
required

Body

application/json
url
string

Webhook endpoint URL

Example:

"https://example.com/webhooks"

events
array[]

Events to subscribe to

Example:
isActive
boolean

Whether the webhook is active

Example:

true

Response

Webhook updated successfully with new configuration.