Configure and manage
This feature is in Dashboard-Alpha
This feature discusses the functionality that is available in Dashboard-Alpha environment.
The webhook management center in Ocrolus Dashboard allows you to manage the organization-level webhook and perform the following actions:
Add webhook
To add a webhook, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select the ADD WEBHOOK button. The Add Webhook screen appears.
-
Enter the following details:
- Description: Enter a brief description of the webhook you want to create.
- Outbound URL: Provide a custom URL to which you want to send notifications from the Ocrolus system.
- Events: Select the events to which you need to subscribe. If you want to subscribe to all the events, select all events.
-
On the Add Webhook screen, select the ADD WEBHOOK button.
-
A success message Webhook added appears and the webhook is added.
Edit webhook
To edit and update webhook details, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select more icon and then select Edit. The Update Webhook screen appears.
-
Make the necessary changes to your webhook and then select UPDATE WEBHOOK.
-
A success message Webhook updated appears and the webhook is updated.
Test webhook
To test the webhook, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select more icon and then select Test. The Test Webhook screen appears.
Note
Only the webhook which is in an Active status can be tested.
-
Select the required event type from the Select Event Type dropdown list and then click the TEST WEBHOOK button.
-
The system runs the test and displays the request status along with the Header and Request sections.
-
Click the CLOSE button to close the Test Webhook pop-up page.
Activate webhook
To activate a webhook, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select the more icon and then select Activate.
Note
Only the webhook which is in Inactive status can be activated.
-
A success message Webhook deactivated appears and the webhook is activated.
Deactivate webhook
To deactivate a webhook, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select more icon and then select Deactivate.
Note
Only the webhook which is in Active status can be deactivated.
-
A success message Webhook deactivated appears and the webhook is deactivated.
Delete webhook
To delete a webhook, perform the following steps:
-
Go to Dashboard > Account & Settings > Webhooks.
-
Select more icon and then select Delete.
-
A confirmation message Are you sure you want to delete this webhook appears. Select CONFIRM.
-
A success message Webhook deleted appears and the webhook is removed from the dashboard.
Updated 3 months ago