Webhook about Sender Status Changes

Last updated: 27 August 2026

This webhook enables you to receive notifications about changes to a channel’s status. When a channel is created, activated, or deactivated, edna Pulse sends an HTTP POST request to the specified URL in your system. This article describes the webhook format and transmitted data.

tip

WhatsApp

Viber

The webhook is available for all channels.

Configuring the URL

To set a URL for a webhook about sender status changes, send a POST request to the URL https://app.edna.io/api/callback/set .

Setting URLs for Webhooks

tip

Your URL should be genuine and accessible to the public via the internet. Only use the secure HTTPS protocol — the default is TCP port 443. URLs can contain a maximum of 500 characters.

info

If a webhook delivery fails, edna Pulse will attempt to resend it up to three times using a backoff scheme: 4, 128, and 2048 seconds after the previous attempt.

You can also specify the webhook URL in your edna Pulse account: Integration → Settings → Main profile → Webhook URL for sender status changes.

General Information about edna Pulse API Keys and Webhooks Managing edna Pulse Webhooks

Webhook format

{
  "type": "string",
  "payload": {
    "sender": "string",
    "status": "string",
    "details": "string"
  },
  "version": "string",
  "timestamp": "string"
}

Webhook examples

Channel created

{
  "type": "sender#created",
  "payload": {
    "sender": "sender_example",
    "status": "ACTIVE"
  },
  "version": "v1",
  "timestamp": "2026-04-16T12:34:00.320Z"
}

Channel is connected and active

{
  "type": "sender#unlocked",
  "payload": {
    "sender": "sender_example",
    "status": "ACTIVE"
  },
  "version": "v1",
  "timestamp": "2026-04-16T12:34:02.160Z"
}

Channel is disabled or blocked

{
  "type": "sender#locked",
  "payload": {
    "sender": "sender_example",
    "status": "LOCKED",
    "details": "license expired"
  },
  "version": "v1",
  "timestamp": "2026-08-14T15:06:00.320Z"
}

Webhook parameters

Parameter	Data type	Character	Description
payload	object	Required	Information about the event type. Possible values: - sender#created — the channel has been created. - sender#unlocked — the channel is connected and active. - sender#locked — the channel is disabled or locked.
payload.sender	string	Required	The name of the channel. To find out the name of the channel, use the API method to get a list of channels — the ‘subject’ parameter. Receiving List of Channels
payload.status	string	Required	Channel status. Possible values: - ACTIVE — connected and active. - LOCKED — disabled or locked.
payload.details	string	Optional	Reason for disabling or locking the channel. Only if payload.status=LOCKED. Possible values: - license expired — the channel license has expired. - license cancelled — the channel license has been revoked. - temporary tenant blocked — the user account is temporarily blocked. - tenant blocked — the personal account is blocked.
type	string	Required	The type of event for which the webhook is sent.
version	string	Required	Webhook version based on the event type.
timestamp	string	Required	The time the channel status was updated. Specified in ISO 8601 format (for example, 2025-07-01T00:00:00Z).

Response format

In response to a request from your server, the status of its execution with the code 200 should be returned.