Skip to main content
This schema describes objects returned by the Webhook Event endpoints.
A webhook event that was sent or attempted to be sent

Fields

FieldTypeRequiredDescription
idstring (uuid)YesUnique identifier for the webhook event (UUID) (read-only)
timestamp_createdstring (date-time)YesTimestamp when the webhook event was created (read-only)
timestamp_created_datestring (date)YesDate when the webhook event was created (for partitioning) (read-only)
organization_idstring (uuid)YesOrganization (workspace) UUID that owns this webhook event (read-only)
payloadobjectNoJSON payload that was sent/attempted to be sent (read-only)
successbooleanYesWhether the webhook call was successful (read-only)
retry_countnumberYesNumber of retry attempts made (read-only)
will_retrybooleanYesWhether the webhook will be retried (read-only)
webhook_urlstringYesTarget URL where the webhook was sent (read-only)
status_codenumber, nullableNoHTTP status code received from the webhook endpoint (if any) (read-only)
error_messagestring, nullableNoError message if the webhook failed (read-only)
timestamp_next_retrystring (date-time), nullableNoTimestamp for the next retry attempt (if applicable) (read-only)
retry_group_idstring (uuid), nullableNoUUID for grouping retry attempts (read-only)
retry_successfulboolean, nullableNoWhether the retry was successful (for retry events) (read-only)
lead_emailstring, nullableNoEmail address of the lead associated with this webhook event (read-only)
response_time_msnumber, nullableNoResponse time in milliseconds for the webhook call (read-only)