VOvoucherifyio
Management

Create Webhook

Creates a new webhook configuration.

📘 Webhook Documentation

Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.

post/management/v1/projects/{projectId}/webhooks

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/management/v1/projects/{projectId}/webhooks
  • Auth
    API key in header X-Management-Id and API key in header X-Management-Token

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 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"
}

Changes

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