Notifications – Webhooks
Webhooks define where and how notifications are delivered to external systems.
Each webhook binds:
- One event (classification or mutation)
- One authentication configuration
- One target URL
Webhooks do not contain any event logic. They only define delivery.
Configuration
Webhooks are configured from the Notifications interface.
Navigate to:
Data Exchange → Notifications → Webhooks
Creating a Webhook
Create a new webhook using the plus icon.
Each webhook defines:
- Name
- Event
- Authentication
- Target URL
Required Configuration Fields
Name
A descriptive name for the webhook.
Example:
ERP – Person Mutations
Event
Select exactly one event:
- One classification event, or
- One mutation event
The webhook will only receive notifications produced by the selected event.
Authentication
Select one authentication configuration.
This determines:
- How the request is signed
- How the receiving system must validate the request
Target URL
The full HTTPS endpoint where Minyu will send the webhook request.
Rules:
- HTTPS is mandatory
- Only HTTP POST is used
- No query parameters are added automatically
Example:
https://api.example.com/minyu/webhook
Delivery Behavior
For every triggered event:
- Minyu sends one HTTP POST request
- The payload is sent as JSON
- Authentication headers are added
- The same payload is reused for retries
Accepted Responses
A delivery attempt is considered successful only if the receiving system responds with:
- HTTP
200
All other status codes are considered failures and trigger retry logic.
Failure & Retry
- Failed deliveries are retried automatically
- Retries use delayed backoff
- There is no maximum retry count guarantee
All attempts are recorded in the Webhooks Log.
Operational Characteristics
- A webhook is bound to exactly one event
- Multiple webhooks can reference the same event
- Multiple webhooks can reference the same authentication configuration
- Webhook delivery is at-least-once