Manage webhooks

Webhooks enable you to receive real-time user event notifications, such as when a user is created, deleted, or logs in to an app. To subscribe to webhook notifications, you need an endpoint (URL) that is set up to receive the events.

For more, see How webhooks work and Set up webhooks.

View webhooks

The Webhooks page lists all existing webhooks and their status, name, and description. To view the Webhooks page, in the side menu select Events > Webhooks.

Create, edit, or delete webhooks

You can manage your webhooks from the Webhooks page:

• Create a webhook by clicking + Add webhook and configuring Webhook settings .
• Edit a webhook by clicking and then Edit .
• Delete a webhook by clicking and then Delete .

Enable or disable webhooks

Enable or disable a webhook by clicking and then selecting Enable or Disable. Notification are only sent to enabled webhooks.

Webhook settings

You can access webhook settings from the Webhooks page by clicking the relevant webhook in the table:

These are the webhook settings:

• Webhook name (required): The name of the webhook to display in the Admin Portal.
• Description : The webhook's description.
• URI (required): The URI to which events are sent. Events must be sent via HTTPS.
• API key (required): An opaque value used to determine that the webhook originated from Mosaic. This value should be kept secret and only used for Mosaic webhooks. See Validate notification .
• Events (required): The types of events for which you want to receive notifications.

Events

You can subscribe to notifications for the following types of events: