Turn dispatch on or off for a platform or a service

PATCH /api/webhooks/dispatch/{platform}

The path segment accepts messaging platforms and also service keys: whatsapp | instagram | facebook | marketing | publishing. With enabled: false Neike keeps receiving from Meta (and metering) everything under that key, but stops hitting your backend. On a platform that covers messages, statuses, send results, template notices and channel notices; on a service (marketing, publishing), its events. Whatever is received stays in the event history with status skipped, so nothing is lost and you can see what arrived while it was off. A platform is turned off as a whole, not per channel: facebook covers all your Messenger channels. Services are independent of the platforms: turning off instagram does not turn off comments, and turning off publishing does not turn off messages. While it is off, retrying those events does not re-dispatch them either. Requires webhooks:manage.

Authentication

Send your API key in the x-neike-api-key header. Console sessions can use a bearer JWT plus x-neike-client-id instead.

Request body

Field	Type		Description
enabled	boolean	required	true turns dispatch on for that key, false turns it off. Strict boolean: any other value, and also a missing field, is 400. Whatever arrives while it is off stays in the event history with status skipped, it is not lost. Example: false.

Responses

Status	Description	Schema
200	—	WebhookConfigResponseDto
400	Unknown dispatch key, or enabled is missing or has a value that is not a boolean.	—

Example

curl -X PATCH https://api.neike.dev/api/webhooks/dispatch/{platform} \
  -H "x-neike-api-key: whk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
       "enabled": false
     }'

WebhookConfigResponseDto

Field	Type		Description
webhook_url	string	required	Configured base URL. Example: "https://tu-backend.com".
webhook_secret_set	boolean	required	true if a shared token (x-webhook-token) is configured. Example: true.
webhook_secret_hint	string	required	Masked hint of the token so you can recognize it (whsec_…abcd). The full value is only returned when it is generated, just once. Example: "whsec_…abcd".
configured	boolean	required	true if a webhook_url is configured. Example: true.
signature_header	string	required	Header with which Neike signs each dispatch. Example: "x-webhook-token".
dispatch_urls	DispatchUrlsDto	required	—
dispatch_platforms	object	required	Dispatch switch, per messaging platform and per service. By default all five are true. It is changed with PATCH /api/webhooks/dispatch/{platform}.
event_urls	EventUrlsDto	required	—