get

/config/v1/webhook

About the API endpoint / method

  • Sending a GET request on this endpoint allows to retrieve a list of all the webhooks or a specific webhook configured for an account.

NB: this GET request does not take any path or query parameter to identify your account - it relies on the apiKey provided to identify which account configuration is being queried.

Request Parameters

1 Header

Responses

1 Example
Schema
array[object]
subAccountId
string
  • Sets the subaccount scope of the webhook.
  • Use * to receive events across all subAccounts.
  • Use the subAccountId to receive events for a specific subaccount.
1 validation + required
type
string

Specifies the type of events received on the webhook. The possible values are:

  • * : events of all types
  • DR: delivery receipts only
  • MO: SMS inbound messages only
  • MSG: SMS and ChatApps inbound messages only
  • EV: Events only (Whatsapp group created, user joined WA group, user left WA group)
1 validation + required
url
string

The url to use for the webhook (Wavecell platform will send events to this url).

2 validations + required
httpAuthorization
string
  • If your webhook requires an authorization, use this parameter to specify it.
  • If specified, the HTTP Authorization header will be passed to your webhook as is.
  • Examples:
    • Basic Authorization example
      • for user:password, you must encode the string user:password in base64 (encoded: dXNlcjpwYXNzd29yZA==)
      • the parameter value should then be set to Basic dXNlcjpwYXNzd29yZA==
    • OAuth Authorization example
      • for ApiKey 9QQhlsEb8VY:
      • the parameter value should be set to Bearer 9QQhlsEb8VY
1 validation
enabled
boolean

Use this flag to enable or disable a Webhook.

2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
api-key