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.
![webhook-dd.png 812](https://files.readme.io/d11b92d-webhook-dd.png)
- Select ADD WEBHOOK button. The Add Webhook screen appears.
![add-blank.png 2838](https://files.readme.io/f6db4c6-add-blank.png)
- Enter the following details:
- Description: Enter a brief description of the webhook that 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.
![add-webhook.png 1522](https://files.readme.io/f04fb2c-add-webhook.png)
-
On the Add Webhook screen, select 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.
![webhook-dd.png 812](https://files.readme.io/4b9445b-webhook-dd.png)
- Select more icon and then select Edit. The Update Webhook screen appears.
![webhook-edit.png 592](https://files.readme.io/ac772d4-webhook-edit.png)
- Make the necessary changes to your webhook and then select UPDATE WEBHOOK.
![update-webhook.png 1468](https://files.readme.io/adc9711-update-webhook.png)
- 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.
![webhook-dd.png 812](https://files.readme.io/4b9445b-webhook-dd.png)
- 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.
![](https://files.readme.io/09d858b-Screenshot_2023-07-12_at_1.18.26_PM.png)
- Select the required event type from the Select Event Type dropdown list and then click the TEST WEBHOOK button.
![](https://files.readme.io/5d873dc-Screenshot_2023-07-12_at_12.20.41_PM.png)
- The system runs the test and displays the request status along with the Header and Request sections.
![](https://files.readme.io/50082d0-Screenshot_2023-07-12_at_2.38.47_PM.png)
- Click the CLOSE button to close the Test Webhook pop-up page.
![](https://files.readme.io/31d8b77-Screenshot_2023-07-12_at_2.40.14_PM.png)
Activate webhook
To activate a webhook, perform the following steps:
- Go to Dashboard > Account & Settings > Webhooks.
![webhook-dd.png 812](https://files.readme.io/d28d82c-webhook-dd.png)
- Select the more icon and then select Activate.
Note:
Only the webhook which is in Inactive status can be activated.
![webhook-activate.png 812](https://files.readme.io/3a0ef6b-webhook-activate.png)
- 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.
![webhook-deactivate.png 782](https://files.readme.io/c820107-webhook-deactivate.png)
- 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.
![webhook-dd.png 812](https://files.readme.io/164453f-webhook-dd.png)
- Select more icon and then select Delete.
![webhook-delete.png 786](https://files.readme.io/bfd0e4d-webhook-delete.png)
- A confirmation message “Are you sure you want to delete this webhook” appears. Select CONFIRM.
![webhook-delete-confirm.png 974](https://files.readme.io/f73faa5-webhook-delete-confirm.png)
- A success message “Webhook deleted” appears and the webhook is removed from the dashboard.
Updated 8 months ago