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 for 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 to your browser to open the Webhooks API information.
Add Webhook
To create a new webhook for your account:
Click ADD ALERT in the upper-right corner of the Webhooks table.
Enter a Name and Description for your webhook.
(Optional) Click Advanced Options at any time to set specific criteria for Logins or Teams.
Click Next.
Enter your Endpoint web address and any required Header Name and Header Value.
(Optional) Click Add Another Endpoint to enter additional endpoint addresses.
Click Next.
Select your desired platform resource from the Resource dropdown.
Select the applicable event from the Event dropdown.
(Optional) Enter a Name and Description for this webhook trigger.
Click Add to configure your new webhook. Notifications will be sent for the Resource and Event combination triggers provided.
Saved Webhooks
The Saved Webhooks section displays a table of webhooks saved to your account, including the following information:
ID: The Payrix Pro-generated ID associated with the saved webhook.
Login: The Payrix Pro-generated ID assigned to the user account that created the webhook.
For Login: The Payrix Pro-generated ID assigned to the user account that is tracked to trigger the webhook.
Name: The name of the webhook.
Description: A description of the webhook.
Status: Whether the webhook is active or inactive.
Saved Webhooks Table Actions
The Saved Webhooks table supports the following actions: delete a webhook and access 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 Alert dialog.
Click YES 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.