List Webhooks

Lists all webhook configurations for the project.

📘 Webhook Documentation

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

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

List Webhooks

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/webhooks \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>'

200

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "object": "webhook",
      "created_at": "2024-01-02T08:31:46.562Z",
      "id": "wh_i45Uez369zzXgh6PXC0eyGmb",
      "events": [
        "redemption.succeeded",
        "redemption.failed",
        "redemption.rollback.succeeded",
        "redemption.rollback.failed",
        "publication.succeeded",
        "voucher.published",
        "voucher.updated",
        "voucher.deleted",
        "voucher.created",
        "voucher.enabled",
        "voucher.disabled",
        "voucher.loyalty_card.points_added",
        "voucher.gift.balance_added",
        "campaign.enabled",
        "campaign.deleted",
        "campaign.created",
        "campaign.updated",
        "campaign.disabled",
        "campaign.vouchers.generation.completed",
        "business_validation_rule.assignment.created",
        "business_validation_rule.assignment.deleted",
        "business_validation_rule.created",
        "business_validation_rule.deleted",
        "business_validation_rule.updated",
        "customer.created",
        "customer.deleted",
        "customer.rewarded",
        "customer.rewarded.loyalty_points"
      ],
      "target_url": "your_url",
      "active": true
    },
    {
      "object": "webhook",
      "created_at": "2024-04-29T14:13:27.764Z",
      "id": "wh_x2YxoHtQdBlP7zfk5KZ8m5WX",
      "events": [
        "redemption.succeeded",
        "redemption.failed",
        "redemption.rollback.succeeded",
        "redemption.rollback.failed",
        "publication.succeeded",
        "voucher.published",
        "voucher.updated",
        "voucher.deleted",
        "voucher.created",
        "voucher.enabled"
      ],
      "target_url": "your_url",
      "active": false
    }
  ],
  "total": 2
}

Authorizations

X-Management-Id · string · header · required

X-Management-Token · string · header · required

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

Response

200

application/json

Returns the details about webhook configurations created in the project.

Object containing a list of webhook configurations.

object · enum<string> · default: list · required

The type of the object represented by JSON. This object stores information about the webhook configurations in a dictionary.

Available options: list

data_ref · enum<string> · default: data · required

Identifies the name of the attribute that contains the array of webhook objects.

Available options: data

data · Management Projects Webhook · object[] · required

Array of webhook objects.

Show child attributes

total · integer · required

The total number of webhook objects.