# Notification API
Send and schedule messages over email, SMS, or push notifications.
WARNING
Scheduled notifications are only sent for users on the Apprentice or Master Wizard plan.
# Send
Send and schedule notifications.
API Base URL
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
medium | String | Medium to use for notification delivery. ("email", "sms", or "push") | Yes |
app | String | App configuration (Default: "default"). (Option only available in the Master Wizard plan.) | No |
date | Date | Schedule this notification for a specific date in the future. | No |
delay | String (Duration¹) | Alternatively, set a delay for this notification to be sent. | No |
interval | String (Duration²) | Enable the recurrent delivery of this notification, e.g. every 2 weeks ("2w"). Duration in minutes is not supported for this parameter. | No |
times | Number | This only applies for recurrent notifications. Limit the number of times the notification will be sent. (Default: until canceled) | No |
| Other Parameters | Various | Please check the parameters applying to your chosen medium from below. | No |
¹ Delay Duration Format: Number followed by unit. Accepted units are "m", "h", "d", and "w" for minutes, hours, days, and weeks, respectively. Examples: "90m", "4h", "30d", "2w".
² Interval Duration Format: Number followed by unit. Accepted units are "h", "d", "m", and "y" for hours, days, weeks, months, and years, respectively. Examples: "4h", "30d", "2w", "3m".
TIP
If you used date or delay to schedule your notification and made it recurrent through the interval parameter, the first notification will be sent on your scheduled date and the second will be sent on your scheduled date + interval duration, and so on!
TIP
Keep track of your scheduled notifications on your Dashboard (opens new window).
Outputs
| Name | Type | Description |
|---|---|---|
success | BoolString | Indicator if the notification was sent successfully. |
id | String | ID of scheduled notification, required to cancel a notification. Only returned if date, delay, or interval was specified. |
Your account requires some prior configuration in order for this API to work for you. Please check out Setting up E-Mail API.
Extra Parameters
| Name | Type | Description | Required |
|---|---|---|---|
to | String | E-Mail address of recipient. | Yes |
subject | String | Subject of the e-mail. | Yes |
templateID | String | E-Mail template to use for this mail. | Yes |
senderEmail | String | Will be displayed as the sender's email.¹ | No² |
senderName | String | Will be displayed as the sender's name.¹ | No. |
¹ If not given, the API will use the sender details specified on the dashboard.
² Parameter is required if a default value has not been configured through the dashboard.
How to Set Template Variables?
Simply append your template variables as parameters to your query.
WARNING
When scheduled e-mails are sent, the template ID applied is used to find the according template and render the mail body with the current version at that time. The action will fail if the template does not exist anymore.
# SMS
Connect Abracadalo to your Twilio (opens new window) account to send and schedule SMS messages using our API!
It is required that you set up your Twilio account first and then set up the connection details in the Adalo Dashboard (opens new window).
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
to | String | Phone number in E.164 format (opens new window) (e.g. "+14155552671"). | Yes |
message | String | SMS message/content. | Yes |
# Push Notification
To use this API, make sure you have connected Abracadalo with your Adalo app in your settings (opens new window).
Also note, from the Adalo Documentation (opens new window):
In order for these API requests to succeed, you must first have at least one native build of your app. The build can be for either iOS or Android, and you do not need to have published your app to the app stores.
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
to | String | E-mail address of an existing record from your users collection. | Yes |
title | String | Title of notification. | Yes |
message | String | Body text of notification. | Yes |
# Cancel
Cancel a scheduled notification. This works for delayed as well as for recurrent notifications.
TIP
Canceling a recurrent notification will not only cancel the next delivery of the notification but the job itself (all future notifications).
API Base URL
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
id | String | ID of scheduled notification as returned by the Notification Send API. | Yes |
Outputs
| Name | Type | Description |
|---|---|---|
success | BoolString | Indicator if the notification was canceled successfully. |
error | String | An error message (if success was "false"). |