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://{{your url}}/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

{
  "status": "success",
  "data": {
    "webhooks": [
      {
        "id": "e0fce57e-1064-4cb4-9b76-8aa8bf4b0678",
        "url": "https://typedwebhook.tools/webhook/46d9467c-b764-478a-a077-56a4d651310d",
        "verb": "post",
        "auth_details": null,
        "auth_type": null,
        "status": "enabled",
        "updated_timestamp": "2023-09-09T19:31:43+02:00",
        "created_timestamp": "2023-08-30T12:33:30+02:00",
        "event_types": [
          "reply",
          "bounce"
        ]
      },
      {
        "id": "ef921b8f-e602-418e-ad3b-ea0663ed6855",
        "url": "https://webhook.site/f0fc8147-0a1a-4e6b-b070-b872812d6649",
        "verb": "post",
        "auth_details": {
          "username": "username",
          "password": "password"
        },
        "auth_type": "basic",
        "status": "enabled",
        "updated_timestamp": "2023-09-12T10:10:16+02:00",
        "created_timestamp": "2023-09-12T10:10:16+02:00",
        "event_types": [
          "sent"
        ]
      }
    ]
  }
}

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 webhooks object

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
  • POST
  • GET

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

  • basic

If this webhook does not require authentication, then this field is left empty (NULL)

status

This indicated if the webhook is enabled or disabled

 String

  • enabled

  • disabled

updated_timestamp

This indicates when the webhook was last updated

 DateTime (Iso8601 format)

created_timestamp

This indicates when the webhook was created

DateTime (Iso8601 format)

event_types

This indicates what events the webhook is monitoring

 Array

  • reply

  • delivered

  • sent

  • failed

  • bounce