GuidesIntegrations

Integrations

Connect OmniTruss to external services, set up webhooks, and leverage APIs for seamless integrations.

{
  "event": "customer.signup",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "customerId": "cust_12345",
    "email": "user@example.com"
  }
}
curl -X GET 'https://api.example.com/v1/customers' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Overview

OmniTruss supports seamless integrations with third-party services, webhooks for real-time notifications, and RESTful APIs for custom automations. Use these tools to connect your customer documentation, self-service portals, and apps with external systems like CRMs, messaging apps, and automation platforms.

All integrations require an active OmniTruss account and API access. Generate your {API_KEY} from the dashboard settings.

Third-Party Service Connections

Connect OmniTruss to popular services using native integrations or OAuth flows. Start by navigating to the Integrations tab in your OmniTruss dashboard.

Webhook Configuration

Set up webhooks to receive real-time events from OmniTruss, such as new customer signups or document updates.

Create Webhook

In the dashboard, go to Settings > Webhooks and click New Webhook.

Configure Endpoint

Enter your endpoint URL, e.g., https://your-webhook-url.com/omnitruss.

Select events like customer.signup or doc.updated.

Test and Activate

Send a test payload and verify receipt. Toggle to activate.

Example webhook payload:

API Endpoints Overview

OmniTruss provides REST APIs at https://api.example.com/v1. Authenticate requests with Authorization: Bearer {YOUR_TOKEN}.

header
Authorizationstring
Required

Bearer token obtained via OAuth or API key.

path
customersstring

Filter customers by ID or email.

Example: List customers.

Automation Triggers

Configure triggers for self-service actions, app deployments, and more. Use the dashboard or API.

Select triggers like New Ticket or Doc Published.

{
  "trigger": "doc.published",
  "action": "notify.slack",
  "channel": "#team-updates"
}

Test automations in sandbox mode first to avoid production disruptions.

Next Steps

Explore advanced integrations: