For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
        • POST10DLC status callback
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
MessagingCampaign RegistryWebhooks

10DLC status callback

|View as Markdown|Open in Claude|
Payload
1{
2  "project_id": "string",
3  "event_at": "string",
4  "event_category": "brand",
5  "event_type": "brand_activated",
6  "state": "string",
7  "brand_id": "string"
8}
Payload sent by SignalWire to your 10DLC Status Callback URL when the state of a 10DLC registration object changes. Use this webhook to monitor the lifecycle of messaging brands, campaigns, number assignment orders, and number assignments in real time. Configure `status_callback_url` when [creating a brand](/docs/apis/rest/campaign-registry/brands/create-brand), [creating a campaign](/docs/apis/rest/campaign-registry/campaigns/create-campaign), or [creating a number assignment order](/docs/apis/rest/campaign-registry/phone-number-assignments/create-order). ### Brand event types | State transition | Event type | Description | |------------------|------------|-------------| | `pending` → `completed` | `brand_activated` | The brand has been successfully verified and activated. | | `pending` → `unverified` | `brand_unverified` | Brand verification failed or additional information is required. | | `unverified` → `completed` | `brand_activated` | The brand was previously unverified but is now active. | ### Campaign event types | State transition | Event type | Description | |------------------|------------|-------------| | `pending` → `active` | `campaign_activated` | The campaign has been approved and is now active. | | `active` → `inactive` | `campaign_deactivated` | The campaign has been deactivated and can no longer send. | ### Number assignment order event types | State transition | Event type | Description | |------------------|------------|-------------| | `pending` → `processed` | `number_assignment_order_processed` | The order has been processed and numbers assigned. | ### Number assignment event types | State transition | Event type | Description | |------------------|------------|-------------| | `pending` → `failed` | `number_assignment_failed` | The number was not assigned to the campaign. | | `failed` → `pending` | `number_assignment_pending` | A failed assignment is being retried. | | `pending` → `completed` | `number_assignment_activated` | The number has been successfully assigned to the campaign. |
Was this page helpful?
Previous

Get short code

Next
Built with

Payload sent by SignalWire to your 10DLC Status Callback URL when the state of a 10DLC registration object changes. Use this webhook to monitor the lifecycle of messaging brands, campaigns, number assignment orders, and number assignments in real time.

Configure status_callback_url when creating a brand, creating a campaign, or creating a number assignment order.

Brand event types

State transitionEvent typeDescription
pending → completedbrand_activatedThe brand has been successfully verified and activated.
pending → unverifiedbrand_unverifiedBrand verification failed or additional information is required.
unverified → completedbrand_activatedThe brand was previously unverified but is now active.

Campaign event types

State transitionEvent typeDescription
pending → activecampaign_activatedThe campaign has been approved and is now active.
active → inactivecampaign_deactivatedThe campaign has been deactivated and can no longer send.

Number assignment order event types

State transitionEvent typeDescription
pending → processednumber_assignment_order_processedThe order has been processed and numbers assigned.

Number assignment event types

State transitionEvent typeDescription
pending → failednumber_assignment_failedThe number was not assigned to the campaign.
failed → pendingnumber_assignment_pendingA failed assignment is being retried.
pending → completednumber_assignment_activatedThe number has been successfully assigned to the campaign.

Payload

The payload of this webhook request is an object.
project_idstringRequired
The unique ID of the project this object is associated with.
event_atstringRequired
The timestamp of when the event occurred, in ISO 8601 format.
event_categoryenumRequired
The category of the event.
Allowed values:
event_typeenumRequired

The specific type of event that occurred. One of: brand_activated, brand_unverified, campaign_activated, campaign_deactivated, number_assignment_order_processed, number_assignment_failed, number_assignment_pending, number_assignment_activated.

statestringRequired
The current state of the object after the event. Possible values depend on the object type.
brand_idstringRequired
The unique identifier for the brand. Present in all event types.
campaign_idstringOptional
The unique identifier for the campaign. Present in campaign, number assignment order, and number assignment events.
number_assignment_order_idstringOptional
The unique identifier for the number assignment order. Present in number assignment order and number assignment events.
number_assignment_idstringOptional
The unique identifier for the number assignment. Present only in number assignment events.
phone_number_idstringOptional
The unique identifier for the phone route itself. Present only in number assignment events.
phone_numberstringOptional
The phone number in E.164 format. Present only in number assignment events.

Response

200
Webhook received