Sign in

The phone_number.imported event is delivered whenever a phone number is imported into Surge from an external provider.

postWebhookphoneNumberImported

Payload

account_idstring required

The ID of the account in which this event occurred

timestampstring date-time required

The timestamp when this event occurred, in ISO8601 format

type'phone_number.imported' required

The type of the event. Always phone_number.imported for this event.

Example payload

{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "campaign": {
      "attachment_status": "attachment_pending",
      "id": "cpn_01jjnn7s0zfx5tdcsxjfy93et2"
    },
    "campaign_id": "cpn_01jjnn7s0zfx5tdcsxjfy93et2",
    "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
    "name": "(801) 555-1234",
    "number": "+18015551234",
    "type": "local"
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "phone_number.imported"
}

Response

Return a 200 status to indicate that the data was received successfully

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.