Events

Most Toll-Free Number (TFN) status changes are asynchronous; you can create a webhook subscription to listen to status change events.

TFN supports the following event webhook types

• tfn.verification

tfn.verification

Verified

  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440001",
    "workspaceId": "550e8400-e29b-41d4-a716-446655440002",
    "phoneNumbers": ["[phone]"],
    "verificationRequestId": "VR-12345",
    "status": "verified",
    "testMode": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z"
  }

With Issue

{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440001",
    "workspaceId": "550e8400-e29b-41d4-a716-446655440002",
    "phoneNumbers": ["[phone]"],
    "verificationRequestId": "VR-12345",
    "status": "rejected",
    "statusMessage": {
      "statusCode": "1101",
      "declineReasonDescription": "Invalid documentation",
      "resubmitAllowed": "true",
      "message": "Please provide valid documentation"
    },
    "testMode": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:35:00Z"
  }