Skip to main content

Webhooks and callbacks in BeLazy

BeLazy's webhook infrastructure​

BeLazy can send any number of POST and GET callbacks to external tools to any URL. For each URL you can define additional headers, and select one or more types of webhooks to be sent. The callback's payload always contains its type, this tells you which event happened.

While the majority of the webhooks help with the BMS Integration use case, the Project closed in BMS event is also the main trigger in the Project Ingestion use case.

Configuring webhooks​

You can set up and configure all webhooks under the Webhooks command in the profile menu. Setting up webhooks using the API is currently not supported.

Testing the webhooks​

Websites such as Requestcatcher allow you to listen to webhooks, and see their payload. If you want to see which event you should catch relating to your BeLazy projects, do the following:

  • Check the tooltip descriptions next to each webhook. We tried to define them as precisely as possible. You may see that certain workflow settings are required for the webhook to be sent.
  • Create a webhook with all the different event types enabled.
  • Now take a project and perform all actions normally, monitoring the changes on the user interface. Webhook events correlate with changes to BeLazy projects on the user interface.

Webhooks and APIsWebhooks and APIs​

Webhooks are meant for notification, and the payload usually contains opportunity or project IDs only. Full information about opportunities and projects may only be available using the get opportunity/get project API call.