WebhookEventErrorLogs
The API maintains an error log where errors are kept for 30 days. An error is logged when the maximum number of retries (5) have been made for an event, but the payload could not be delivered. The error log allows the error to be recovered and processed by the integration to make sure changes are not missed.
The error log can be queried, and will return the entire payload content, subject to the standard 500 record limit.
NOTE Integration developers can only access the error logs for callouts they themselves have created.
NOTE To keep the error log clean, you should delete any errors you have addressed.
Entity details
You can also retrieve this information with the The getEntityInfo() SOAP API call call (for the SOAP API) or with the EntityInformation call (for the REST API).
Entity Name: | WebhookEventErrorLog |
---|---|
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Fields
Field Name Label and Description |
Datatype | Read Only | Is Required | Reference Name |
---|---|---|---|---|
AccountWebhookID <EntityName> Webhook ID
This value represents the internal ID assigned to a webhook. It is always prefaced with the name of the entity. EXAMPLE Account Webhook ID |
integer | <EntityName>Webhook (SOAP API) | ||
ContactWebhookID <EntityName> Webhook ID
This value represents the internal ID assigned to a webhook. It is always prefaced with the name of the entity. EXAMPLE Account Webhook ID |
integer | <EntityName>Webhook (SOAP API) | ||
CreateDateTime Create Date Time
This field records the date and time the error occurred. The error will remain in the log for 30 days after the recorded date. |
datetime | |||
ErrorMessage Error Message
The ErrorMessage field records the response to the webhook callout. |
string (8000) | |||
id Webhook Event Error Log ID
This field defines an ID which uniquely identifies a webhook event that generated an error. |
long | |||
Payload Payload
This field records the information that is included in the callout HTTP POST. This data includes both system fields and UDFs, and fields where IsDisplayAlwaysFields = True, as well as triggering fields. |
string (8000) | |||
SequenceNumber Sequence Number
This value is a number that increments with each successive callout. If the recipient gets a number less than the last number they received, they know they are out of order. |
integer |