A webhook is an automated notification sent from the API server when triggered by a specific action that occurs in your portfolio. You can configure the actions that trigger the webhooks to notify you of any event that’s important to your business model. The Webhooks page contains information about notifications associated with your account and allows you to create new webhooks or edit existing ones.
Note
By default, all webhooks are disabled. You must enable webhooks by using the Add Webhook feature on this page.
To learn more about webhooks, see Set Up Webhooks.
To access the Webhooks page, select Webhooks in the Admin category of the left navigation panel.
Create Webhooks Link
The Create Webhooks Link is located at the top of the page and contains a link to the specific view of the portal for the user with access to the Webhooks page. You can use the Create Webhooks link to sign up with another site that periodically pulls notifications based on the configuration of that third-party site.
Copy the link using the clipboard icon and paste into your browser to open the Webhooks API information.
Add Webhook Button
The Add Webhook button is located below the Create Webhooks Link section.
To create a new webhook for your account:
Click ADD WEBHOOK to open the Add Webhook dialog.
Name your webhook.
Enter the webhook name and any descriptive information.Click NEXT in the lower right corner of the page.
Attach endpoints by entering the web address that will receive the webhook.
Enter any additional information about the endpoints in the Advanced Section.
Note: Optionally enter additional endpoint addresses by clicking ADD ANOTHER ENDPOINT below the form.Click NEXT in the lower right corner of the page.
Set a trigger to tell our API when to alert you.
Choose the resource and event from the available dropdown menus and enter any additional information.
Note: Optionally enter additional triggers by clicking ADD ANOTHER TRIGGER below the form.To save your information and add the new webhook, click ADD in the lower right corner of the page.
Saved Webhooks
The Saved Webhooks section displays a table of webhooks saved to your account, including the following information:
ID: The ID number associated with the saved webhook.
Login: The ID assigned to the user account that created the webhook.
For Login: The ID assigned to the user account that is tracked to trigger the webhook.
Team: If a Team or group of users receives the webhook, the team name will be displayed in this column.
Name: The name of the webhook.
Description: A description of the webhook.
Saved Webhooks Table Actions
The Saved Webhooks table supports deleting a webhook and accessing more information about a saved webhook.
To delete a webhook:
Click the X icon in the far right column of the table to open the Delete Webhook dialog.
Click CONFIRM to delete the webhook.
To access more information about a specific saved webhook, click any information in the row to open the Webhook Details page.
Related pages
Click the links or items on the page to access any of the following pages: