Webhook

To enable asynchronous call responses (Webhooks), store the token provided in the initial API response.

Fields

FieldTypeDescription
TokenguidThis is the unique id in our system for your request.
SuccessbooleanDid we successfully process this request?
ResponseCodeintSee “Response Code Reference” for a description of each code
MessagestringA brief description of what happened.
ProcesseddatetimeoffsetThe current DTO of when we finished processing this request.
{ 
"Token": "27C3CF6D-5542-4106-AF37-BF16045D6535",
"Success": true,
"ResponseCode":1,
"Message":"Success"
"Processed": "2017-06-12T05:45:24.1996732+00:00"
}

Response Codes

Code(s)Description
0An unknown failure has occurred.
1, 24The transaction was successful, no errors.
2The Record was created, but an error occurred in the routing action.
3, 8A general error occurred during the Record insert.
4The data provided for the Record was invalid. For example, it could be missing required information such as Phone.
5A duplicate of the Record you are trying to insert already exists.
6, 12An invalid Phone number was provided.
7An error occurred for the Record based on project settings.
9The record was created, but an error occurred in the first Drip of the assigned campaign.
11The CountryCode provided is invalid.
13Invalid data was provided.
14An error occurred trying to route the Converted record.
15An error occurred trying to route the Closed record.
21The LongURL provided was invalid.
22A ShortURL failed to be assigned to the record.
23The area code provided is invalid.
25The Record was successfully routed to a project.
26An error occurred when trying to route the Record to the project.
27The Record was rejected due to carrier being blacklisted.