The broadcast object
Attributes
action_urlnullable string
max length: 2048
categorystring or nullable
contentnullable string
max length: 10485760
custom_attributesnullable object
overridesnullable object
recipientsarray of objects or object objects
min items: 1
max items: 1000
titlestring
min length: 1
max length: 255
Handles the create notification request.
Request body
action_urlnullable string
max length: 2048
categorystring or nullable
contentnullable string
max length: 10485760
custom_attributesnullable object
overridesnullable object
recipientsarray of objects or object objectsrequired
min items: 1
max items: 1000
titlestringrequired
min length: 1
max length: 255
Request body
app_idstring
device_tokenstringrequired
min length: 64
installation_idenum
Possible enum values:
development
production
Request body
app_idstringrequired
badgeenumrequired
Possible enum values:
unread
unseen
certificatestringrequired
The APNs certificate in PEM format. Generate it at [developer.apple.com](https://developer.apple.com/account/resources/authkeys/add) with the 'Apple Push Notification service (APNs)' option selected.
key_idstringrequired
min length: 10
max length: 10
payload_versionenum
Possible enum values:
1
2
team_idstringrequired
min length: 10
max length: 10
Request body
auth_provider_x509_cert_urlstringrequired
auth_uristringrequired
client_emailstringrequired
client_idstringrequired
client_x509_cert_urlstringrequired
payload_versionenum
Possible enum values:
1
2
private_keystringrequired
Request body
webhook_signing_secretstringrequired
The signing secret to verify incoming requests from Github
min length: 1
max length: 100
Request body
imagesnullable objectrequired
localenullable stringrequired
min length: 2
themenullable objectrequired
Request body
imagesnullable objectrequired
localenullable stringrequired
min length: 2
themenullable objectrequired
Request body
api_keystringrequired
min length: 1
domainstringrequired
min length: 1
regionenumrequired
Possible enum values:
us
eu
Request body
endpointstring
HTTP endpoint to send requests to (testing only)
min length: 1
fromobject
key_idstringrequired
AWS Access Key ID
min length: 1
regionstringrequired
AWS Region
min length: 1
secret_keystringrequired
AWS Secret Key
min length: 1
Request body
app_idstringrequired
client_idstringrequired
client_secretstringrequired
min length: 32
max length: 32
signing_secretstringrequired
min length: 32
max length: 32
Request body
access_tokenstringrequired
app_idstringrequired
authed_userobjectrequired
bot_user_idstring
enterpriseobject
expires_ininteger
idstring
Request body
webhook_signing_secretstringrequired
The signing secret to verify incoming requests from Stripe
min length: 1
max length: 100
Request body
account_sidstringrequired
The SID for your Twilio account
min length: 1
max length: 100
api_keystringrequired
The API key for Twilio
min length: 1
max length: 100
api_secretstringrequired
The API Secret for Twilio
min length: 1
max length: 100
fromstringrequired
The phone number to send from, in E.164 format
min length: 1
max length: 100
regionenum
The region to use for Twilio, defaults to 'us1'
Possible enum values:
us1
ie1
au1
Request body
expiryinteger
The duration for which the token is valid (in seconds)
namestringrequired
The name of the token.
max length: 255
Request body
emailstring
The user's email.
max length: 255
expiryinteger
The duration for which the token is valid (in seconds)
external_idstring
A unique string that MagicBell can utilize to identify the user uniquely. We recommend setting this attribute to the ID of the user in your database. Provide the external id if the user's email is unavailable.
max length: 255
namestring
The name of the token.
max length: 255