API Reference

Notifications

Types of Notifications


Notifications inform you about the status of a transaction resource you are involved in. We currently support notifications on events so you don't have to keep checking your dashboard for the state of your account or deliveries.


TypeDescription
delivery statusEvents of a change in the status of a delivery
balance statusEvent of a low balance

Notification Channels


Notification channels are where and how the Stalls One API sends you updates. They can be turned off / on with the exception of webhooks, which cannot be turned off.

ChannelDescriptionSent toContentStatus
WebhookEvent-driven, programmatic notifications on change in status of resourcesWebhook URLJSON payload in a POST requestsupported
SMSEvent-driven, human-language notifications on change in status of resourcesPhone numberText of less than 160 characterscoming soon
EmailEvent-driven, personalised and graphical notifications on change in status of resourcesEmail addressHTML emailcoming soon

Webhook Events