CRcreem
Webhooks

Acknowledge a CLI webhook event

Changed on

Report the status your local server returned for an event from the pending feed. Any 2xx marks the delivery successful; anything else records a failure. Acknowledged events leave the pending feed and appear in the dashboard event log with the reported result. Only valid for endpoints created with delivery_mode: cli.

post/v1/webhooks/{id}/events/{event_id}/ack

Request

Path parameters

idstring required

The webhook ID

event_idstring required

The event ID from the pending feed

Request body

status_codenumber required

The HTTP status code the local server answered with. Any 2xx marks the delivery successful. Report 503 when the local server could not be reached.

response_bodystring

The response body the local server returned, truncated to 10,000 characters. Shown in the dashboard event log.

Example request

{
  "status_code": 200,
  "response_body": "OK"
}

Response

Successfully acknowledged the event

idstring required

The acknowledged event ID.

objectstring required

A string representing the object’s type. Objects of the same type share the same value.

successboolean required

Whether the first acknowledgment recorded a successful delivery (any 2xx). Repeated acknowledgments return the stored result.

Example response

{
  "id": "evt_5Xb2mQ7vN1pLk9RtYw3zA",
  "object": "webhook_event",
  "success": true
}

Changes