Webhook Event Reference

When you subscribe to events in the Webhook Integration, our system will send a POST request with a JSON payload to your specified endpoint whenever that event occurs. This guide details the available events.

Segment Events

These events fire when you manage segments within the API central settings.

  • segment.created
    Sent when a new segment is created.
  • segment.updated
    Sent when a segment is updated (e.g., its title or connected Campaign ID is changed).
  • segment.deleted
    Sent when a segment is deleted.

Player & Prize Events

These are the core events that fire based on user interaction with your live campaigns.

  • player.created
    Sent when a new unique user submits a registration form in an integrated campaign. The payload will contain all the data from the form fields.
  • prize.assigned
    Sent when a user meets the criteria to win a prize. The payload will contain details about the player and the prize they won, including any unique codes.