Appearance
Webhooks
Webhooks provide a way for your application to receive notifications when events occur.
Instead of periodically checking for changes, your application can subscribe to the events it is interested in and receive a notification when those events occur.
How Webhooks Work
Webhooks are configured from the KMaker platform. When configuring a webhook, you can select the events your application wants to receive and provide the endpoint where those events should be delivered.
When a subscribed event occurs, KMaker sends an HTTP POST request to the configured endpoint.
text
Configure webhook
│
│ Select events
▼
Event occurs
│
▼
Webhook delivery
│
│ HTTP POST
▼
Your application
│
├── Verify signature
│
└── Process eventYour application is responsible for receiving the webhook, verifying its signature, and processing the event.
Why Use Webhooks?
Webhooks are useful when your application needs to react to events as they happen.
For example, you can use webhooks to:
- Synchronize data with your system
- Trigger business workflows
- Update records when an event occurs
- Send notifications
- Start background processing
Webhooks can also reduce the need for your application to repeatedly poll for changes.
Events
A webhook can be subscribed to one or more event types.
Each event has a unique event type and a defined payload structure.
For example:
text
ALERT:CREATED
ALERT:UPDATED
ALERT:RESOLVEDSee Events for the complete list of available events and their payload schemas.
Webhook Deliveries
When a subscribed event occurs, KMaker sends a webhook delivery to your configured endpoint.
Each delivery contains:
- An event identifier
- The event type
- The event creation time
- Event-specific data
- A signature for request verification
See Webhook Delivery for information about the request format, idempotency, retries, and responses.
Security
Each webhook delivery includes a signature that allows your application to verify the authenticity and integrity of the request.
A webhook secret is generated when configuring a webhook and can be rotated when needed.
Your application should verify the signature before processing the event.
See Signature Verification for details.
Getting Started
To start receiving webhook events:
- Configure a webhook and its destination endpoint.
- Select the events your application wants to receive.
- Configure your application to receive webhook deliveries.
- Verify the webhook signature.
- Process events according to their event type.
See Getting Started to begin.