Webhooks
Supported Events
Today, we we support the following event type:
access.requested
This event is triggered when a user requests access to your Trust Center for the first time. When you set up the Webhook in Conveyor, additional details about the structure of the payload will be made available.
Have other ideas for events you would like Webhook support for? Please let us know at [email protected].
Setup
Conveyor Webhooks are powered by Svix. If enabled, the payload of your webhook will flow through and temporarily be stored on Svix servers in the USA. Svix has been reviewed and secured in accordance with our compliance commitments. For additional details see https://trust.conveyor.com and https://www.svix.com/security/.
Prerequisite
You must be an Account Owner to enable webhooks.
Steps
- Navigate to the Webhook Preferences page
- Toggle the "Enable Webhooks" button
- Choose to "Add Endpoint"
- For the "Endpoint URL" choose where you would like the Webook to be sent
- Add a "Description" if relevant
- Subscribe to the relevant event using the checkbox
- Click "Create" at the bottom of the window
Once created, the Webhook will begin sending events to the Endpoint URL you have defined. The Webhooks page in Conveyor will allow you to send test events to begin troubleshooting a workflow in the system you are catching the Webhook with.
Use Cases
Use Webhooks to automate approving access requests to Conveyor based on the presence of a user in a CRM/application that Conveyor does not support a native integration with (like Hubspot, Pipedrive, Monday.com, Dynamics365, or Microsoft Teams).
You can send the Webhook to a workflow automation tool such as Zapier, and then build a workflow to check if that user exists (for instance in Hubspot).
Then use the Conveyor API to approve the pending request if your check passes. The benefit of Webhooks is total flexibility with taking action based on any event originating in Conveyor
Updated 3 months ago