Promotion Webhooks

Each promotion can have up to 1 webhook defined that will be called upon each successful redemption.

Note: a successful response from the webhook is not required for a successful redemption of the promotion, so customers will be able to receive your promotion even if your webhook is down.

Upon redemption a POST request will be made to the URL specified containing the following data:

{
    "promotion": {
        "id": "1234",
        "title": "My Promotion Title"
    },
    "customer": {
        "id": "5678",
        "firstName": "John",
        "lastName": "Smith",
        "email": "js@example.com",
        "mobile": "+61 411222333"
    }
}

Unless a 2xx response is received within 10 seconds the webhook will be recorded as failed. The failed webhook data is recorded, but at present there is no way to "replay" failed webhooks.

Some examples for what you can do with this webhook:

  1. Email or SMS a ticket to the customer
  2. Update an internal CRM with the redemption info
  3. Email or SMS them a unique voucher code for an external loyalty system (eg: discount voucher for online store)
  4. Subscribe them to a VIP mailing list (eg buy in to VIP offers)