{
"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"
}Events
phone_number.imported
Fires when a phone number is imported into Surge from an external provider.
WEBHOOK
phoneNumberImported
{
"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"
}Fires when a phone number is imported into Surge from an external provider, such as through porting or hosting. The event includes the number’s ID, E.164 format, type, and any campaign attachment details available at import time.
Imported numbers are not necessarily ready for production messaging yet. If a campaign is associated with the number, check
data.campaign.attachment_status. When attachment completes, Surge fires phone_number.attached_to_campaign instead.
Common use case
Usephone_number.imported to update your own records when a ported or hosted number becomes available in Surge, for example, to notify a customer that their import finished or to start tracking campaign attachment for that number.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The ID of the account in which this event occurred
The data associated with the event
Show child attributes
Show child attributes
The timestamp when this event occurred, in ISO8601 format
The type of the event. Always phone_number.imported for this event.
Allowed value:
"phone_number.imported"Response
200
Return a 200 status to indicate that the data was received successfully