docunite® NEOInstall

Summary

Create a new webhook by specifying its name, callback URL, event types to listen for, an authentication secret, and the provider type, with optional additional configuration fields.

Inputs

• Name (required) — The name to assign to the webhook.
• Callback URL (required) — The URL that will receive webhook callbacks.
• Event Types (required) — One or more event types that trigger the webhook; options are Extraction, Classification, and Enrichment.
• Secret (required) — A secret key used to authenticate the webhook on the receiving side.
• Provider Type (required) — The type of provider receiving the webhook; options include Custom Provider, Microsoft Teams, and docunite® Real Estate DMS.
• Additional Fields — Optional JSON object containing additional configuration fields for the webhook.

Output shape

a single JSON object representing the created webhook's details.

The operation sends a POST request to the /webhooks endpoint with the provided parameters merged with any additional fields. The returned data includes the webhook created by the docunite® NEO API.

Examples

Example 1: Create a webhook named 'DocumentEvents' that listens to Extraction and Classification events and sends payloads to a Microsoft Teams channel with an authentication secret.

Set 'Name' to 'DocumentEvents', 'Callback URL' to the Teams incoming webhook URL, 'Event Types' to ['EXTRACTION', 'CLASSIFICATION'], 'Secret' to your secret key, and 'Provider Type' to 'Microsoft Teams'.