Creating & Configuring Webhooks

๐Ÿ‘‹ Make sure to read this content before continuing

How Events & Webhooks Work


Coding Webhooks


๐Ÿ‘

Even if you are a seasoned professional we recommend you review WebHook Best Practices.

๐Ÿ‘

Creating a WebHook for a Custom Event?

You can use the PostEvent Extension API to trigger custom events for debugging.


Configuring WebHooks


๐Ÿ“˜

Using the Client Extension?

Configurations are managed by the Client Extension and should not be updated with the UI. Find out more about how configurations are managed by reading Deploying The Client Extension.

  1. Navigate to your Corporate Admin instance.
  2. Select Tools, then Developer Tools from the main menu.
  3. Click on Webhooks.
  4. Click on the Add Event button.
  5. Using the Event Id drop-down menu, select the Id for the event you'd like to subscribe to.
    • Select Custom Event to manually enter a Custom Event ID.
    • Click the Show Events List button to restore the Custom Event ID field to its original drop-down format.
    • For a complete list of standard Event Ids, see Webhook Events and Payloads.
  6. Select an Application.
    • This drop-down menu allows you to manage multiple registrations for the same event to different Client Web Applications.
  7. Enter a valid URL for the Endpoint.
    • Example: https://externalApp1.com/api/webhooks/CreateAssociateEvent
894

Figure 1. Add Event modal in Corporate Admin