Webhooks

Update a Webhook Endpoint

Updates a Webhook Endpoint

patch/webhook-endpoints/{webhook_endpoint_id}

Request

Path parameters

webhook_endpoint_idstring required

The identifier of the Webhook Endpoint to update.

Request body

eventsWebhookEvent[] required

A list of Events that the Webhook Endpoint should subscribe to.

Example request

{
  "events": [
    "payments.merchant.updated"
  ]
}

Response

The Webhook Endpoint was updated successfully.

idstring required

A unique identifier representing a specific Webhook Endpoint.

urlstring required

The URL of the Webhook Endpoint.

eventsWebhookEvent[] required

A list of Events that the Webhook Endpoint is subscribed to. The Webhook will receive a POST request when any of these Events occur.

createdAtinteger required

The exact time, in epoch milliseconds, when this Webhook Endpoint was created.

updatedAtinteger nullable

The exact time, in epoch milliseconds, when this Webhook Endpoint was last updated.

Example response

{
  "id": "webhook_endpoint_eead1d640d7c",
  "url": "https://example.com/webhook",
  "events": [
    "payments.merchant.updated",
    "payments.network-token.updated"
  ],
  "createdAt": 169297262323,
  "updatedAt": null
}

Changes

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