VOvoucherifyio
Management

Get Webhook

Retrieves a webhook configuration.

📘 Webhook Documentation

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

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

Request

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

Response

Returns 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.