Skip to main content

​
Webhook Events

This page provides an overview of all available webhook events. Each event type has its own detailed documentation page.

​
Event Types

​
Action Log Events

Track agent activity and action completion:

Action Log Completed

Fired when an action completes successfully

Action Log Failed

Fired when an action fails

​
Document Events

Track document collection and processing:

Document Received

Fired when a document is received

Document Extracted

Fired when document extraction completes

​
Webhook Delivery

​
Request Format

Webhooks are sent as HTTP POST requests with:
  • Content-Type: application/json
  • Method: POST
  • Body: JSON payload containing the event data

​
Response Requirements

Your webhook endpoint should:
  • Return a 200 OK status code within 5 seconds
  • Handle requests asynchronously if processing takes longer
  • Return appropriate error codes for invalid requests

​
Retry Logic

If your endpoint doesn’t respond with a 200 status code, OmniAI will retry:
  • Initial retry: After 1 minute
  • Subsequent retries: Exponential backoff
  • Maximum retries: 3 attempts

​
Security

​
Webhook Secrets

For enhanced security, you can configure a webhook secret. OmniAI will include this secret in the webhook request headers, allowing you to verify request authenticity.

​
Best Practices

  • Use HTTPS endpoints only
  • Verify webhook signatures when possible
  • Implement idempotency to handle duplicate events
  • Set up retry logic for failed webhook deliveries
  • Monitor webhook delivery status

Webhooks User Guide

Learn how to set up webhooks

Create Webhook API

Create webhooks via API

List Webhooks API

List your webhooks