v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Management

Update Webhook

Updates a webhook configuration.

The "events" listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.

📘 Webhook Documentation

Read Introduction to webhooks article to learn how webhooks work in Voucherify.

put/management/v1/projects/{projectId}/webhooks/{webhookId}

Request body

target_urlstring

URL address that receives webhooks.

eventsstring[]

Lists the events that trigger webhook sendout.

activeboolean

Determines if the webhook configuration is active.

Response

Returns the details about the updated webhook configuration.

idstring required

Unique identifier of the webhook.

object'webhook' required

The type of the object represented by JSON.

created_atstring date-time required

Timestamp representing the date and time when the webhook configuration was created. The value for this parameter is shown in the ISO 8601 format.

target_urlstring required

URL address that receives webhooks.

eventsstring[] required

Lists the events that trigger webhook sendout.

activeboolean required

Determines if the webhook configuration is active.

Example response

{
  "id": "wh_i45Uez36Uz8XNW6PXC0eyGmb",
  "created_at": "2024-01-02T08:31:46.562Z"
}