Setting Up a Webhook

You can set up a webhook by using the ADD WEBHOOK form to provide the necessary details. Follow the steps in this topic to set up a Webhook for your deployment.

1. Click the Webhooks tab.

2. On the Webhooks page, click Add WEBHOOK. The Add Webhooks form appears.

   

3. Provide the following details:

   • Name: A name that is unique and does not exceed 512 characters.

     If you specify a name that already exists, you'll see a warning message when you click the Save button.

   • Base URL: The HTTPS URL where a webhook will be sent.

   • Trigger event: A trigger event that initiates the webhook. Only one event can be selected per webhook, although multiple webhooks that target the same pools can be created.

     Info

     Currently, only the following events are supported: Allocate Resource, Session Start, and Session End.

4. Provide the following optional details:

   • Description: A user friendly description of the webhook. Limited to 1024 characters.

   • Associated Pool(s): Zero or more dynamic pools, selected from a list of existing pools.

     Info

     If no pools are selected, a webhook can be set up, but cannot be triggered.

     Info

     It is also possible to assign a special value All, instead of selecting every pool in the list, but in this version the only way to do that is using API. Once added, the value shall be visible in the Associated Pool(s) field. In future releases, it will be possible to assign All from the UI.

   • Payload: The content of the Payload field is sent to the specified URL AS IS. The payload must be formatted as a valid JSON:

   • Certificate details: Select a CA certificate in PEM format.

5. Click SAVE.