PORT_DATA_SUCCEEDED

Fired when the information required to port a user's phone number to another carrier has been successfully retrieved from their merchant account.

postWebhookport_data_succeeded

Payload

eventstring

Name of the webhook event.

session_idstring

Unique identifier for the session.

task_idinteger

Unique identifier for the task.

external_user_idstring

Unique identifier for the user.

timestampinteger

Unix timestamp of the webhook event in UTC.

Example payload

{
  "event": "PORT_DATA_SUCCEEDED",
  "session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
  "task_id": 25605,
  "external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
  "merchant": {
    "id": 296,
    "name": "AT&T",
    "logo": "https://knot.imgix.net/merchants/eg2HJmeltHCvsQmJTSQPCIJT3CBaPA2gV0HixEQO.png?auto=format&w=240"
  },
  "data": {
    "user": {
      "name": {
        "first_name": "Ada",
        "last_name": "Lovelace"
      },
      "address": {
        "street": "100 Main Street",
        "street2": "#100",
        "city": "NEW YORK",
        "region": "NY",
        "postal_code": "12345",
        "country": "US"
      },
      "phone_number": "+11234567890"
    },
    "account_number": "123456789012",
    "transfer_pin": {
      "pin": "123456",
      "expires_at": "2026-08-28T17:45:00Z"
    },
    "metadata": {
      "reference_token": "abc123",
      "trace_id": "def456"
    }
  },
  "timestamp": 1710864923198
}

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.