All Collections
Notifications and WebHooks
Notifications and WebHooks

How we notify other systems

Diego Pereda avatar
Written by Diego Pereda
Updated over a week ago

An important section of the Zenvia Conversion API was built to notify other systems when certain events occur within the Zenvia Conversion platform.

The API notifies other systems via a request HTTP POST at a registered URL, and sends information related to the event within the body. This technique is generally known as Webhook.

Currently, the events (known as Topics) that can be reported to a registered URL are:

  • When a prospect is created in Zenvia Conversion (via receiving and validating a lead)

  • When a quote is updated or its status is modified

  • When an agent completes an interaction.

Registering and using notifications

Once you have the API key to access the Zenvia Conversion API, you can register a new subscription to certain events (topics) and you will be able to specify a URL at which you would like to be notified (callbackURL). You can do all this directly from the Notifications section of the API.

Once you have subscribed, every time an event (Topic) occurs within the platform, Zenvia Conversion will notify the callback URL you registered via a request HTTP POST.

You can review or delete the available subscriptions at any time, directly via the Notifications API.

Remember that in order to access the API you will need an API Key.

Related articles:

Did this answer your question?