API endpoint reference: teams, webhooks, members and agents

Omnifox REST v1 endpoints to manage teams, outbound webhook subscriptions, members and agent availability.

Jun 26, 2026

Watch this step in the video · The API documentation

Introduction

Omnifox's REST API v1 lets you automate teams, outbound webhooks and agents from your own systems. API base: https://omnifox.io/api/v1. Every call uses a Bearer token (a Sanctum personal access token) generated in Settings → API Keys (/api-keys). The list identifies it by a visible omf_… prefix, but the value you send in the header looks like 123_aBc…. Each token is scoped to a single workspace: you cannot operate on another workspace with the same token.

Authorization: Bearer 123_aBc...yourFullToken
Content-Type: application/json

Teams

  • GET /v1/teams — list teams. Optional ?workspace_id= filter.
  • POST /v1/teams — create a team. Body: workspace_id (req), name (req), description, assignment_strategy.
  • GET /v1/teams/{team} — returns the team with its members.
  • PUT /v1/teams/{team} — update name, description, assignment_strategy.
  • DELETE /v1/teams/{team} — delete the team.

Team members

  • POST /v1/teams/{team}/members — add a user. Body: user_id (req).
  • DELETE /v1/teams/{team}/members/{user} — remove a user from the team.
  • GET /v1/teams/{team}/members/{user} — check a single membership; returns { is_member, role }.
  • GET /v1/users/{user}/teams — teams an agent belongs to (workspace-scoped).

Outbound webhooks

  • GET /v1/webhooks — list subscriptions with delivery stats.
  • POST /v1/webhooks — create a subscription. Body: name (req), url (req), events (req, array), headers, retry_count, timeout_seconds. On creation an HMAC secret is generated and a test ping is sent to the URL.
  • GET /v1/webhooks/{webhook} — detail with recent delivery logs.
  • PUT /v1/webhooks/{webhook} — update url, events, is_active, etc.
  • DELETE /v1/webhooks/{webhook} — delete the subscription.
  • POST /v1/webhooks/{webhook}/rotate-secret — regenerate the signing_secret.

Available events: contact.created/updated/deleted, conversation.created/closed/resolved/pending/assigned, message.received/sent/delivered/read/failed, note.created, call.started/ended, agent.assigned/status_changed, tag.added/removed, workflow.completed, broadcast.completed.

Every delivery carries the X-Omnifox-Signature (HMAC-SHA256 of the body) and X-Omnifox-Timestamp headers. Verify them on your endpoint with the signing_secret.

Agents and availability

  • GET /v1/agents — list agents with their availability status and workspace assignments. Filters: ?workspace_id=, ?status=, ?team_id=.
  • GET /v1/agents/{agent} — detail with workspaces, teams and stats (assigned_open_conversations, total_conversations_handled). Each assignment includes max_concurrent_conversations.
  • PUT /v1/agents/{agent}/status — change availability. Body: workspace_id (req), status (req: available, busy, away, offline). Broadcasts the change in real time.

The on-shift schedules that decide who gets auto-assigned are configured per workspace; the API exposes the resulting availability via status.

Verify

Test your token with GET /v1/teams. A 200 with JSON confirms the Bearer is valid and scoped to the right workspace.

Tips

  • The REST API is available from the Crece plan, and the request limit depends on your plan: Crece 1,200/min, Escala 2,400/min, Exclusivo unlimited. On 429, retry with backoff.
  • Store each webhook's signing_secret in a vault: it is only shown on creation or rotation.

Related articles

Was this helpful?

Related articles

Message us on WhatsApp