OCoctaneai
webhooks

Update webhook subscriptions or status

patch/v1/webhooks/{endpoint_id}

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Path parameters

endpoint_idstring required

Request body

topicsstring[] nullable

The topics to receive; absent leaves them

include_piiboolean nullable

Send contact details; absent leaves it

enabledboolean nullable

false disables the endpoint, true enables it again; absent leaves it

descriptionstring nullable

Your own label; null clears it, absent leaves it

Response

The updated endpoint.

idstring required

The endpoint

urlstring required

Where deliveries are sent

topicsstring[] required

The topics the endpoint receives

status'pending' | 'active' | 'disabled' | 'paused_plan' required

pending: waiting for its first successful ping | active | disabled | paused_plan: the store's plan has no API access

include_piiboolean required

Whether payloads carry contact details (identities and email and phone answers)

descriptionstring nullable required

Your own label for the endpoint; null when unset

created_atstring date-time required

When the endpoint was created

updated_atstring date-time required

When it last changed

verified_atstring date-time nullable required

When its first ping succeeded; null before

disabled_atstring date-time nullable required

When it was disabled; null while enabled

disabled_reasonstring nullable required

merchant: you disabled it | gone: it answered 410 | failing_five_days: it kept failing for five days; null while enabled

consecutive_failuresinteger required

Failed deliveries in a row; a success resets it

failing_sincestring date-time nullable required

When the current run of failures began; null when the last delivery succeeded

last_delivered_atstring date-time nullable required

When a delivery last succeeded; null before any

Example response

{
  "id": "whe_7c9e6679742540de944be07fc1f90ae7",
  "failing_since": "2026-09-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.