A webhook integration allows you to send BloxOne notifications to a designated application by using a unique URL. When setting up your a webhook service, you can choose to use the default webhook template or construct a custom template for a specific payload for your webhook notification.
In this dialog, you will be configuring a webhook integration that allows you to send BloxOne notifications to a designated application using a unique URL.
Complete the following to set up the webhook service
| Note |
|---|
To ensure that notifications associated with an existing custom webhook service function properly when you modify the service configuration, you must first disable the notifications associated with the service. After you are done with the changes, you can enable the notifications again. For information, see the Modifying Custom Webhook Services section in this topic. |
Creating New Webhook Services
To set up a new webhook service, do the following:
- Log in to the Cloud Services Portal.
- On the left navigation panel, go to Notifications > Service Integrations tab.
- Click Add Service Integration and specify the following:
- Type: From the drop-down menu, select Custom to set up a webhook integration.
- Name: Enter the name of the webhook service. BloxOne uses this name on the Notification Settings page, for configuration purposes. For more information, see Configuring Notification Settings.
- URL: Enter the URL of the application to which you want BloxOne to send notifications. Email notifications in a standardized JSON format are sent to this URL.
- Authentication: From the drop-down menu, choose the authentication method for this webhook integration:
- None: No authentication is required for this integration.
- Basic: Enter the username and password for basic authentication.
- Token: Enter the access token to be used for authentication.
Template: A template determines the output of your webhook notification. You can create a custom webhook template in the editor provided here. BloxOne supports the Go template format: a standard template used to generate textual output. For information about Go templates, see https://pkg.go.dev/text/template. If you do not provide a custom template, BloxOne generates the payload according to the supported fields in the default template. For more information, see Default Webhook Template and Supported Keys.
- Webhook Context: Note the following when creating a custom webhook template:.
- You can include actions in your template by specifying user-defined key-value pairs in Webhook Context. When generating the payload, BloxOne uses the keys and values you define.
- If you compose a valid template but have not defined any key-value pairs in Webhook Context, then BloxOne obtains the values from the database, if the values exist. For the keys that do not have values, only the key names with empty values will appear in the payload.
- If you compose a valid template but do not include certain keys you have defined in Webhook Context, BloxOne ignores those key-value pairs, so they will not appear in the payload.
- If your custom template includes supported keys from the default template, and if you have defined key-value pairs for them in Webhook Context, the user-defined values will override the default values, if applicable.
...
| Note | ||
|---|---|---|
| ||
| After you have added or configured new services, they will appear in the Application Notificationsthe Service Integrations section of the Notification SettingsNotifications page. Ensure that you select the new services if you want to send notifications to them. For information on how to configure notification settings, see Configuring Notification Settings. |
Modifying Existing Webhook Services
If you need to modify an existing webhook service, you must first disable all notifications associated with the service. You can then make changes to the webhook service before enabling notifications again.
To modifying an existing webhook service, do the following:
- Log in to the Cloud Services Portal.
- On the left navigation panel, go to Notifications.
- Click Admin Settings on the upper right-hand corner of the page.
- In the Admin Settings dialog, expand the Service Integrations section.
- Deselect all the notification check boxes for the respective webhook service to which you plan to make changes.
- Click Save & Close.
- Go to the Notifications > Service Integrations tab.
- Click Edit on the webhook service you want to modify.
- In the edit dialog, make the required changes, and then click Save & Close. See the Creating New Webhook Services section for more information.
- Click Admin Settings on the upper right-hand corner of the page again.
- In the Admin Settings dialog, expand the Service Integrations section.
- Select the check boxes of the notifications that you want to enable for the modified webhook service.
- Click Save & Close.