Setting up a Challo webhook

Your applications, or other external services, can use webhooks so that they can communicate with Challo automatically.

Authorization

Your application can send requests to Challo to perform actions on your behalf automatically. Challo requires that your applications include a webhook key to authorize each action they make. You create a webhook key for applications to use on your behalf. The actions that your application performs using your webhook key are equivalent to you performing the action yourself. Your application has the same privileges and permissions as you do.

Important: The value of the webhook key should remain secret because Challo uses this parameter to authorize the requests it receives.

Generating a webhook key

To generate a webhook key,

  1. Click your avatar.
  2. Click Profile.
  3. Below Webhook keys, click Add.
  4. Enter a name for the key.
  5. Click Add.
  6. Challo generates a key that the person can use to authenticate their webhook requests.

Webhook host and endpoint

Your application directs webhook requests to the following endpoint:

POST https://app.cafex.com/be/webhook

Parameters and headers

Each request that your application sends to Challo has to include an HTTP Authorization header with the value: Bearer <webhook key>.

HeaderValue
AuthorizationYour application provides an Authorization header so that Challo can authorize the requests. The header has to be in the format:
Authorization Bearer <webhook key>

Webhook actions

The following actions are available: