Skip to content

Campaign webhooks

Aura sends a webhook for every moment of a plan, so your app can tell the customer what happened, in your own voice and channels.

In the dashboard, under Developers, then Webhooks, add your HTTPS endpoint and copy its signing secret. Each event type can be switched on or off for each endpoint. Sandbox endpoints get events from test actions, and you can send a test event of any type from the dashboard. Both carry "test": true.

Event Sent when data.object
plan.started The customer accepted and the plan started. The first week’s data is on its way. Plan
plan.at_risk The warning time came and this week’s action isn’t in. Tell the customer the plan cancels unless they act. Plan
plan.cancelled A week ended without its action. can_restart_from says when the customer can start again. Plan
plan.resized A plan that grows moved up to its bigger size. data.previous holds the size before. Plan
plan.renewed The customer kept the plan through a whole month. data.recap holds the month just ended. Plan
reward.delivered The network confirmed the data was credited. Your balance was charged. Reward
reward.failed A delivery failed. Nothing was charged and the hold was released. Reward
reward.flagged A reward is waiting for your review in the dashboard. Reward
reward.rejected An action earned nothing, with its reason. Also when a flagged reward is rejected in review, or data lapses because the customer didn’t accept in time. data.reward is the reward, when there was one. Action
campaign.paused A campaign paused: by your team, on reaching its budget, on its end date, or when your Aura plan wasn’t renewed. data.reason says which. Campaign
balance.low Your available balance fell below its warning level. data.days_left says how long it lasts. Balance

reward.rejected goes out for actions uploaded by CSV too, so every team gets the same answers. It isn’t sent for customers in the comparison group, who were never offered a plan.

campaign.paused gives its data.reason as paused_by_business, budget_reached, end_date_reached or aura_plan_unpaid. A campaign paused because your Aura plan wasn’t renewed goes live again once a new period is paid.

data.object is the whole plan, reward, action, campaign or balance, exactly as the API returns it at that moment. The full schemas are in the API reference.

POST /webhooks/aura HTTP/1.1
Content-Type: application/json
Aura-Event-Id: evt_01JAD9K3W7N2Q5T8R1F4H6P3MX
Aura-Event-Type: plan.at_risk
Aura-Timestamp: 1792796404
Aura-Signature: v1=3d9a1c7e5b2f80e4a6c1d9b7f3e5a2c8d0b6f4e1a9c7d5b3f1e8a6c4d2b0f9e7
{
"id": "evt_01JAD9K3W7N2Q5T8R1F4H6P3MX",
"object": "event",
"type": "plan.at_risk",
"created_at": "2026-10-23T23:00:04Z",
"test": false,
"data": {
"object": {
"id": "pln_01JAC4XB7Q2W9D8M5X4N6B1C0V",
"object": "plan",
"customer_id": "CUS-204871",
"name": "Your 6GB plan from Your Savings App",
"status": "at_risk",
"current_period": {
"number": 3,
"ends_at": "2026-10-25T22:59:59Z",
"kept": false,
"actions_needed": [{ "key": "weekly_deposit", "name": "Weekly deposit" }],
…
},
…
}
}
}

This customer’s week ends at 11:59pm on Sunday 25 October, Lagos time, and a deposit of at least ₦5,000 before then keeps the plan.

Campaign webhooks are signed, retried and delivered exactly like every Aura webhook:

  • Verify the signature before you trust anything in the event.
  • Acknowledge with any 2xx within 10 seconds, then do slow work, such as messaging the customer.
  • A failed delivery is retried for up to 24 hours.
  • The same event can arrive more than once, and events can arrive out of order. Record each Aura-Event-Id you process and ignore repeats. When order matters, read the plan or reward as it is now, from the API.

If your endpoint was down, nothing is lost: every plan and reward can be looked up once it is back.