Skip to main content

Webhooks

Each organization might provide a webhook URL (Update Organization) to receive updates when certain actions occur:

A Campaign Image is Approved/Declined​

{
  "id": "<image_id string>",
  "campaign_id": "<campaign_id string>",
  "url": "<image url string>",
  "status": "approved | declined"
}

Organization Balance is Changed​

{
  "id": "<transaction_id string>",
  "campaign_id": "<campaign_id string>",
  "details": "string",
  "balance_currency": "usd",
  "balance": "<amount string>",
  "amount": "<amount string>",
  "currency": "usd",
  "created_at_utc": "datetime with offset"
}

A Campaign Status is Changed​

{
  "campaign_id": "<campaign_id string>",
  "status": "created | running | completed | stopped"
}

Testing Webhooks​

  • On Production: Actions are triggered by external events.
  • On Test: To trigger these events, use the simulator API: Simulator API Docs.