How to configure webhooks and their events

Overview

1. Set up and configuration
2. Troubleshooting

1. Set up and configuration

Whenever trigger events occur in the platform, the webhook is sent to the HTTPS or SFTP endpoint you provided. 

If your HTTPS endpoint requires authentication, it is possible to configure headers.

Details on the payloads can be found here.

The webhooks can be set at platform level:

or at flow level:

• Webhooks associated with rounds, tickets and some task events are configured at the platform level

Administration > Platform > General > Integrations 

• • round.created
  • round.validated
  • round.published
  • round.in_preparation
  • round.ongoing
  • round.completed
  • round.analytics
  • ticketCreated
  • ticketUpdated
  • ticketClosed
  • taskStatusChanged
  • taskChanged
  • taskRejected

  

  • The URL, protocol and subscribed events need to be selected (1. Rounds, 2. tickets, and 3. tasks)
  • Webhooks associated with tasks, optimizations and announcements are configured at the flow level

  Administration > Flows > Advanced mode > Webhooks

  • • taskStatusChanged
    • taskChanged
    • optimisationComplete
    • announcementComplete
    • announcementCancelled
    • tasksAnnounced

  

  • You can also select a header and description,  as well as activate the notification for none delivery in this section. These email notifications can minimize problems associated with webhook errors. Further information on this can be found here. 

   

  2. Troubleshooting

  To determine why or where a specific webhook fails you can follow the steps below:

  • • Check if the trigger was met

    • Check if the webhook was set up properly (URL endpoint)

    • Check if there is a filter on the webhook (Sender, Optimization)

    • Check the system monitor (see article for more details): 

      • If nothing can be found, please contact our Support team and provide them with the initial troubleshooting achieved.