Webhooks
  • 04 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Webhooks

  • Dark
    Light
  • PDF

Article summary

On the Webhooks page, you can:

  1. View webhook details (related actor types, URL, owner name, creation date, and status)
  2. Copy a webhook ID by clicking the copy icon in the URL column.
  3. Sort webhooks chronologically, alphabetically, or by status by clicking the needed column name (URL, Owner, Create date, and Status).
  4. Create a webhook.
  5. Change the webhook status.
  6. Perform auxiliary actions.

Webhook page

Create webhook

To create a webhook:

  1. In the upper-right corner of the Webhooks page, click Create webhook.
    Create webhook button

  2. In the Create webhook dialog, enter a webhook URL, select the needed checkboxes for the actions you want to track, and click Create.
    create webhook1

The webhook has been created, and you can see it in the list.
Webhook created

Webhook notifications types

You can use webhooks to track actions and events related to the following groups:

  • Users: users' status change and management.
  • Invites: creation and deletion of user invitations to workspaces.
  • Groups: user groups creation and management.
  • Roles: user roles creation and management.
  • API Keys: API keys creation and management.
  • State changes: management and notifications on state change balance within your license.

Change webhook status

After creating a webhook, it has the Active status by default. To change the status to Inactive, turn the Status toggle to the left side. The status has been changed, and the success message appears at the top of the page.

Success message

Click the red dot to see the reason for the status change.
Status reason

Perform auxiliary actions

On the Webhooks page, you can perform auxiliary actions on a webhook:

Auxil acts

Edit webhook

To edit a webhook:

  1. On the Webhooks page, hover over the needed webhook and click the edit icon Edit icon2 that appears.
    Edit webhook

  2. In the Modify webhook dialog, select or clear the needed checkboxes for tracked actions and click Modify.
    modify webhook

The webhook has been modified, and the success message appears at the top of the page.

Webhook modified

Delete webhook

To delete a webhook:

  1. On the Webhooks page, hover over the needed webhook and click the trash icon Trash icon that appears.
    Delete webhook

  2. In the Delete webhook confirmation dialog, click Delete.
    Delete webh dialog

The webhook has been deleted and doesn’t appear in the webhook list on the Webhooks page.


Was this article helpful?