Client webhook config

GET /api/webhooks/config

Base URL that Neike dispatches to, the final URLs per platform (WhatsApp/Instagram/Facebook), the dispatch switch of each platform and each service, and the URLs of the platform events (marketing, publishing and embedded signup) with the event names that arrive at each one. The shared token (x-webhook-token) is NOT returned: only a masked hint. It is shown in full just once, when it is generated. 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.

Responses

Status	Description	Schema
200	—	WebhookConfigResponseDto

Example

curl -X GET https://api.neike.dev/api/webhooks/config \
  -H "x-neike-api-key: whk_live_…"

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	—