Registering Webhooks

This page will document how to Register webhooks for our API to use.

Receive Web Hook notifications, register your webhook endpoint. Please provide a publicly accessible HTTPS URL to your webhook endpoint.

POST /webhooks/receipt

Used to register for Delivery Receipt notifications.

Curl

curl -X POST \
"https://api.mobivatebulksms.com/webhooks/receipt" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "url": "https://your.domain.com/endpoint" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'url': 'https://your.domain.com/endpoint',
}

response = requests.post('https://api.mobivatebulksms.com/webhooks/receipt', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "url": "https://your.domain.com/endpoint" }'
#response = requests.post('https://api.mobivatebulksms.com/webhooks/receipt', headers=headers, data=data)

Incoming Messages

POST /webhooks/incoming

Use to register for Incoming Message notifications.

Curl

/curl -X POST \
"https://api.mobivatebulksms.com/webhooks/incoming" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "url": "https://your.domain.com/endpoint" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'url': 'https://your.domain.com/endpoint',
}

response = requests.post('https://api.mobivatebulksms.com/webhooks/incoming', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "url": "https://your.domain.com/endpoint" }'
#response = requests.post('https://api.mobivatebulksms.com/webhooks/incoming', headers=headers, data=data)

Short URL Clicks

POST /webhooks/click

Use to register for Short URL Click notifications.

Curl

curl -X POST \
"https://api.mobivatebulksms.com/webhooks/click" \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [API Key]' \
-d '{ "url": "https://your.domain.com/endpoint" }'

Python

import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer [API Key]',
}

json_data = {
    'url': 'https://your.domain.com/endpoint',
}

response = requests.post('https://api.mobivatebulksms.com/webhooks/click', headers=headers, json=json_data)

# Note: json_data will not be serialized by requests
# exactly as it was in the original request.
#data = '{ "url": "https://your.domain.com/endpoint" }'
#response = requests.post('https://api.mobivatebulksms.com/webhooks/click', headers=headers, data=data)

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer [API Key]

Body

Name	Type	Required?	Description
url	string	Yes	URL to receive Delivery Receipt notifications.

Response

We use conventional HTTP response codes to indicate the success or failure of an API request. In general:

2xx indicate success 4xx indicate an error that failed given the information provided (e.g., a required parameter was omitted) 5xx errors indicate an error with ours servers (these are rare).

200

{
   "message":"Webhook updated successfully"
}

401

{
   "code":401,
   "message":"Unauthorized"
}

To see a full list of our Response codes, please click here.