List webhooks

GET

campaign

{id}

webhooks

curl --request GET \
  --url https://api.sendo.dev/v1/campaign/{id}/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

Parameters

string

required

The ID of the campaign to list webhooks for.

Response

webhooks

object[]

List of webhooks for the campaign.

Show webhook fields

string

The ID of the webhook.

createdAt

timestamp

The time the webhook was created

name

string

The name of the webhook (optional).

url

string

The URL of the webhook.

campaignId

string

The campaign ID for the webhook.

signature

string

The signature sent with events. (read more)

eventTypes

string

The events the webhook will receive. (read more)

Show event types

message.incoming

string

Subscribed to incoming messages.

message.status

string

Subscribed to message status updates.

recipient.optout

string

Subscribed to recipient opt-outs.

numbers

string[]

The phone numbers the webhook is subscribed to.

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

curl --request GET \
  --url https://api.sendo.dev/v1/campaign/{id}/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

GET

campaign

{id}

webhooks

curl --request GET \
  --url https://api.sendo.dev/v1/campaign/{id}/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

Parameters

string

required

The ID of the campaign to list webhooks for.

Response

webhooks

object[]

List of webhooks for the campaign.

Show webhook fields

string

The ID of the webhook.

createdAt

timestamp

The time the webhook was created

name

string

The name of the webhook (optional).

url

string

The URL of the webhook.

campaignId

string

The campaign ID for the webhook.

signature

string

The signature sent with events. (read more)

eventTypes

string

The events the webhook will receive. (read more)

Show event types

message.incoming

string

Subscribed to incoming messages.

message.status

string

Subscribed to message status updates.

recipient.optout

string

Subscribed to recipient opt-outs.

numbers

string[]

The phone numbers the webhook is subscribed to.

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

curl --request GET \
  --url https://api.sendo.dev/v1/campaign/{id}/webhooks \
  --header 'Authorization: Bearer <token>'

{
  "webhooks": [
    {
      "id": "d3392dbf-ae4b-43b9-9b50-dcafa5c7h4mn",
      "createdAt": "2023-12-31T03:07:35.826Z",
      "name": "Event Service",
      "url": "https://website.com/webhook",
      "campaignId": "g1tkV7Eq",
      "signature": "aVWS7HTLR9xxMkdE",
      "eventTypes": [
        "message.incoming",
        "message.status"
      ],
      "numbers": [
        "+14159436397"
      ]
    },
    {
      "id": "c29b55aa-a622-4f99-91ba-1dc5834734eb",
      "createdAt": "2023-12-15T03:07:35.826Z",
      "name": "Revocation Service",
      "url": "https://website.com/revocations",
      "campaignId": "g1tkV7Eq",
      "signature": "7ujOMdfiow43feAS",
      "eventTypes": [
        "recipient.optout"
      ],
      "numbers": [
        "+14159436397"
      ]
    }
  ]
}

​Parameters

​Response

Coming soon

​Parameters

​Response

Parameters

Response

Parameters

Response