plan.started
Sent when a customer accepts their plan and it starts, whether it was offered after an action or by an offer. The first week’s data is delivered then.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”The event’s unique ID. The same event delivered twice has the same ID.
Example
evt_01JAC7T2Q4N8M3B6H6K8P1D5QSExample
reward.deliveredWhen this delivery attempt was signed, in Unix seconds.
Example
1792489320v1= followed by the lowercase hex HMAC-SHA256 of {Aura-Timestamp}.{raw body}, keyed with your webhook
secret. During a secret rotation the header carries two signatures separated by a comma.
Example
v1=8c3e0f2b9e8a41b3c6d0e9f2a7b4c1d8e3f6a9b2c5d8e1f4a7b0c3d6e9f2a5b8Request Bodyrequired
Section titled “Request Bodyrequired”object
Same as the Aura-Event-Id header.
true for events from test actions and for test events sent from the dashboard.
object
object
The plan’s name as customers see it.
not_offered: the customer is in the comparison group. offered: the plan was offered, after its start
action or by an offer, and waits for the customer to accept. active: accepted, and this period is kept or
still open. at_risk: the warning has gone
out and this period’s action isn’t in yet. cancelled: a period ended without its action. ended: the
customer held the plan for its full length, or the campaign ended.
The number that gets the data. null until the customer accepts.
How often the plan’s data arrives, and so how long each period is.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
The period in progress. null when the plan isn’t running.
object
Which period of the plan this is, from 1.
When plan.at_risk goes out if the period isn’t kept by then.
Whether this period’s action is in.
The actions that keep this period, with their readable names for your screens.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
When the plan grows next, if a plan that grows is on.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
When the plan was offered, by its start action or by an offer.
When the customer accepted and the plan started.
When a cancelled plan can start again, in Lagos time. null when it can’t restart.
The first day the customer can change their number again.
The plan terms the customer agrees to when they accept. text already has the plan’s name, amounts and your
app’s name filled in: show it unchanged on your own plan screen, and send version as terms_version when
the customer accepts. The plan card shows the same text.
object
The terms’ version.
The terms as plain text, ready to show.
The same terms as a web page.
On plan.resized, the size before.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
On plan.renewed, the month just ended.
object
An amount of mobile data in gigabytes (GB), as set in the plan, to at most two decimal places.
Responses
Section titled “Responses”Return any 2xx status within 10 seconds to acknowledge the event.
© 2026 PressOne Africa Limited ·poweredbyaura.com ·Privacy ·Terms