Affiliate Program Events

A comprehensive list of events that can activate webhooks for affiliate program changes, including creation, updates, and deletions.

Events

Event	Description
`affiliate-program-created`	Triggers whenever a new affiliate program is created.
`affiliate-program-updated`	Triggers whenever an affiliate program is updated.
`affiliate-program-removed`	Triggers whenever an affiliate program is deleted.

Webhook Payload Examples

affiliate-program-created

{
  "event_id": "whev_yde55ox9jhgqr5evp",
  "event_type": "affiliate-program-created",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate_program": {
      "object": "affiliate_program",
      "products": [],
      "domain": "bc06950e-226c-4a6f-82b1-bff6fe170374",
      "label": "20% Commission",
      "created_at": 1671644300,
      "signup_url": null,
      "id": "68ea0c41-a7ed-4169-b0dc-72f0f0eb404b",
      "currency": "EUR",
      "commission_amount": 0,
      "commission_percent": 20,
      "description": "Promote our new line of clothing and receive 20% commission!",
      "payout_delay": 0,
      "subscription_commission_type": "once",
      "destinations": [
        "worldwide"
      ],
      "payments": [
        "stripe"
      ],
      "is_public": false,
      "auto_approve": false,
      "is_listed": false,
      "payment_count": null,
      "affiliate_notifications": false,
      "banners": null
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}

affiliate-program-updated

{
  "event_id": "whev_755exqnrhpwd2k39",
  "event_type": "affiliate-program-updated",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate_program": {
      "object": "affiliate_program",
      "products": [
        "5a3da42d-d007-49e0-937d-8388d45ba05e",
        "7701d669-d936-4938-9d5b-6eb31a277e51"
      ],
      "domain": "bc06950e-226c-4a6f-82b1-bff6fe170374",
      "label": "20% Commission",
      "created_at": 1671644300,
      "signup_url": null,
      "id": "68ea0c41-a7ed-4169-b0dc-72f0f0eb404b",
      "currency": "EUR",
      "commission_amount": 0,
      "commission_percent": 20,
      "description": "Promote our new line of clothing and receive 20% commission!",
      "payout_delay": 0,
      "subscription_commission_type": "once",
      "destinations": [
        "worldwide"
      ],
      "payments": [
        "stripe"
      ],
      "is_public": false,
      "auto_approve": false,
      "is_listed": false,
      "payment_count": null,
      "affiliate_notifications": false,
      "banners": null,
      "affiliates": 0,
      "sales": 0
    },
    "changes": [
      "products"
    ]
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}

affiliate-program-removed

{
  "event_id": "whev_52wkmxwdvc6q9nkqv",
  "event_type": "affiliate-program-removed",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate_program": {
      "id": "68ea0c41-a7ed-4169-b0dc-72f0f0eb404b"
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}