Overview
Call this endpoint as a GET request to get a list of all available webhooks associated with your account.
Endpoint
| Method | URL |
|---|---|
| GET | https://{{your url}}/api/2.0/production/sms/webhooks |
Requests
Example Curl Request
curl --location 'https:///api/2.0/production/sms/webhooks'
Responses
Status Codes
|
Status Code |
Explanation |
|---|---|
| 200 OK |
Webhooks retrieved successfully |
| 401 Unauthorized | The provided authorization credentials are incorrect |
200 OK
Response Body Example
Top Level Response Properties
|
Property |
Sub-Property | Explanation | Data Type |
|---|---|---|---|
| Status |
|
This field is used to determine whether the request succeeded or failed. |
String |
| Data |
This holds an array with a |
Array |
|
| Data | Webhooks |
This field holds an array of webhooks |
Array |
Lower Level Response Properties
|
Property |
Sub-Property | Explanation | Data Type |
Possible Values |
|---|---|---|---|---|
| id |
|
This is the unique ID for the webhook |
String | |
| url |
This is the webhook URL that is being used for this configured webhook |
String | ||
| verb |
This is the method that is used when pushing data to the webhook |
String |
|
|
|
auth_details |
This is the authentication details if the webhook requires authentication |
Array | ||
| auth_details | username |
This is the username portion for basic authentication details for the webhook |
String | |
| auth_details | password |
This is the password portion for basic authentication details for the webhook |
String | |
| auth_type |
This is the authentication type that the webhook may user |
String |
If this webhook does not require authentication, then this field is left empty ( |
|
|
status |
This indicated if the webhook is enabled or disabled |
String |
|
|
|
updated_timestamp |
This indicates when the webhook was last updated |
DateTime (Iso8601 format) |
||
|
created_timestamp |
This indicates when the webhook was created |
DateTime ( |
||
|
event_types |
This indicates what events the webhook is monitoring |
Array |
|