Sign in

v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Channel

Test webhook

Sends a test webhook callback to the specified URL.

post/settings/webhook_test

Request body

type'messages' | 'statuses' | 'chats' | 'contacts' | 'groups' | 'presences' | 'calls' | 'channel' | 'users' | 'labels' | 'service' required
send_undecrypted_adboolean

Send a webhook for an ad that could not be decrypted.

webhook_max_age_secondsnumber nullable

Time in seconds. If the message is delayed more than this time, the hook will not be sent.

headersobject

Additional headers for webhook. Max 5 headers. <br/>Example: <br/>"Authorization - Bearer token" <br/>"Content-Type - application/json" <br/>"X-Header - value"

urlstring required

Inbound and outbound notifications are routed to this URL.

mode'body' | 'path' | 'method' required

Request method for sending hook.

Response

OK

successboolean