Campaign status update

This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

WEBHOOK campaignStatusUpdate

Example

{
  "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j",
  "createDate": "<string>",
  "cspId": "<string>",
  "isTMobileRegistered": true,
  "type": "TELNYX_EVENT",
  "description": "Campaign has been marked as dormant",
  "status": "DORMANT"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

telnyx-timestamp · integer<int64> · required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

telnyx-signature-ed25519 · string · required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/json

brandId · string

Brand ID associated with the campaign.

Example:

"d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5"

campaignId · string

The ID of the campaign.

Example:

"4b300178-131c-d902-d54e-72d90ba1620j"

createDate · string

Unix timestamp when campaign was created.

cspId · string

Alphanumeric identifier of the CSP associated with this campaign.

isTMobileRegistered · boolean

Indicates whether the campaign is registered with T-Mobile.

type · enum<string>

Available options: TELNYX_EVENT, REGISTRATION, MNO_REVIEW, TELNYX_REVIEW, NUMBER_POOL_PROVISIONED, NUMBER_POOL_DEPROVISIONED, TCR_EVENT, VERIFIED

Example:

"TELNYX_EVENT"

description · string

Description of the event.

Example:

"Campaign has been marked as dormant"

status · enum<string>

The status of the campaign.

Available options: ACCEPTED, REJECTED, DORMANT, success, failed

Example:

"DORMANT"

Response

200

The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL.