Webhook Subscribers

Update a Webhook Subscriber

Update an existing Webhook Subscriber by its ID

post/webhook-subscribers/{id}

Path parameters

idstring required

Request body

recipientUrlstring

The URL to send the webhook to. Must be a valid HTTPS URL

subscribedTostring[]

activeboolean

Whether the webhook subscriber is active. Deactivating pauses webhook delivery to this subscriber rather than cancelling it: events queued while it is inactive are held, and reactivating the subscriber resumes their delivery. A held event is not held indefinitely — one that stays undelivered past the delivery deadline is abandoned.

Example request

{
  "recipientUrl": "https://my-be-url.com/webhooks",
  "subscribedTo": [
    "customer.created"
  ]
}

Response

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the webhook subscriber

activeboolean required

Whether the webhook subscriber is active and will receive events

recipientUrlstring required

The URL where webhook events will be delivered via HTTP POST

subscribedTostring[] required

The list of event types this subscriber receives webhooks for. Covers lifecycle events for customers, subscriptions, payments, transactions, invoices, products, and prices.

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "active": true,
  "recipientUrl": "https://my-backend.com/webhooks",
  "subscribedTo": [
    "customer.created",
    "customer.updated"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.