Configure a Webhook
How to configure code to occur when triggered by a user action in Bullseye.
|Requirements: Any paid subscription|
Webhooks are a way for apps to communicate with websites automatically. In a nutshell, a webhook sends a programmed set of data when triggered by an event to a URL, where the data is received, and code is executed using the data. For example, Paypal uses a webhook to tell your accounting app when your clients pay you.
At this time, user activation is the only available trigger available for webhooks in Bullseye. User activation occurs when a user clicks the Register button after filling in user information on the registration form. Users reach the registration form by direct URL, or via the activation link in the invitation to the system.
Add a Webhook
To access the webhook configuration page go to Settings > Webhook Configuration. To add a new webhook, select Add Webhook. You will see this screen:
Configure the following options:
- Under Webhook Information, check the Enabled option to enable a new webhook.
- Select a User Activation trigger event from the Event dropdown.
- Name the webhook. This name can be anything - it’s helpful if you provide a descriptive name indicative of the purpose of the webhook, like “Update user’s Salesforce status”
- Enter the endpoint URL of the webhook. This is the URL that will receive the data from the webhook, and execute code with that data. Bullseye does not configure the endpoint. The user activation webhook will send the following data that can be used by the endpoint:
- Optionally, configure an HTTP Auth Username and Password if your endpoint requires it.
- Optionally, configure custom headers with additional values to be used by the endpoint. To add a header, click the Add Headerbutton.
- After configuring the webhook, click the Save button
Note: It is possible to configure multiple webhooks for multiple endpoints. All configured webhooks will fire on any User Activation trigger.
Monitor a Webhook
Bullseye tracks each time the webhook is triggered and reports on the activity. To view the Webhook Activity Report, click on Reportsfrom the navigation options on the left, and select Webhook History.