HOhookdeck
Events

Cancel an event

Changed on

This endpoint cancels a pending event. Only events with a status of QUEUED, SCHEDULED, or HOLD can be cancelled.

put/events/{id}/mute

Request

  • Base URL
    https://api.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring required

Event ID

Response

A cancelled event

idstring required

ID of the event

team_idstring required

ID of the project

webhook_idstring required

ID of the associated connection (webhook)

source_idstring required

ID of the associated source

destination_idstring required

ID of the associated destination

delivery_groupstring nullable

Delivery group computed from the destination delivery groups config

event_data_idstring required

ID of the event data

request_idstring required

ID of the request that created the event

attemptsinteger required

Number of delivery attempts made

last_attempt_atstring date-time nullable required

Date of the most recently attempted retry

next_attempt_atstring date-time nullable required

Date of the next scheduled retry

response_statusinteger nullable

Event status

error_code'BAD_RESPONSE' | 'CANCELLED' | 'TIMEOUT' | 'NOT_FOUND' | 'CANCELLED_PAST_RETENTION' | 'CONNECTION_REFUSED' | 'CONNECTION_RESET' | 'MISSING_URL' | 'CLI' | 'CLI_UNAVAILABLE' | 'CLI_BINARY_UNSUPPORTED' | 'SELF_SIGNED_CERT' | 'ERR_TLS_CERT_ALTNAME_INVALID' | 'ERR_SSL_WRONG_VERSION_NUMBER' | 'NETWORK_ERROR' | 'NETWORK_REQUEST_CANCELED' | 'NETWORK_UNREACHABLE' | 'TOO_MANY_REDIRECTS' | 'INVALID_CHARACTER' | 'INVALID_URL' | 'SSL_ERROR_CA_UNKNOWN' | 'DATA_ARCHIVED' | 'SSL_CERT_EXPIRED' | 'BULK_RETRY_CANCELLED' | 'DNS_LOOKUP_FAILED' | 'HOST_UNREACHABLE' | 'INTERNAL_ERROR' | 'PROTOCOL_ERROR' | 'PAYLOAD_MISSING' | 'UNABLE_TO_GET_ISSUER_CERT' | 'SOCKET_CLOSED' | 'OAUTH2_HANDSHAKE_FAILED' | 'Z_DATA_ERROR' | 'UNKNOWN'

Error code of the delivery attempt

status'SCHEDULED' | 'QUEUED' | 'HOLD' | 'SUCCESSFUL' | 'FAILED' | 'CANCELLED' required
successful_atstring date-time nullable required

Date of the latest successful attempt

cli_idstring nullable required

ID of the CLI the event is sent to

updated_atstring date-time required

Date the event was last updated

created_atstring date-time required

Date the event was created

Changes

  • 9bebff6c68f9Revision changes
    • warning

      added the new CLI_BINARY_UNSUPPORTED enum value to the response property for the response status

    • info

      added the optional property / to the response with the status