Get Webhook Event

Get Webhook Event

get

Retrieves a single WebhookEvent by ID.

Path parameters
webhook_idinteger · int32Required
event_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
chevron-right
default

default response

application/json

Webhook Event

idinteger · int32Read-onlyOptional
app_idinteger · int32Optional

App ID

webhook_idinteger · int32Optional

ID of the webhook the event occurred on

entity_idinteger · int64Optional

ID of entity this event occurred for

entity_external_idstringOptional

External ID of entity this event occurred for

status_codeinteger · int32Optional

HTTP Status Code

responsestringOptional

Response from the remote url

event_typestring · enumOptional

Type of webhook event

Possible values:
remote_endpointstringOptional

Remote endpoint the webhook event was sent.

attemptsinteger · int32Optional

Deliver attempts of the webhook the event

statusstring · enumRequired

Status of webhook event

Possible values:
date_createdstring · date-timeRead-onlyOptional

Date of creation

date_last_modifiedstring · date-timeRead-onlyOptional

Date of last update

date_next_attemptstring · date-timeRead-onlyOptional

Date of next delivery attempt

get
/events/webhooks/{webhook_id}/events/{event_id}
default

default response

Last updated

Was this helpful?