Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Regal Reporting Webhooks

Regal publishes 40+ reporting webhook event types covering agent activity, call lifecycle (placed, completed, IVR triggered, wrapup), call recording and transcript availability, AI call analysis, task reservations, SMS lifecycle (queued, sent, received, failed, undelivered, conversation completed), MMS, email, voicemail (recording and transcript availability, completion), contact lifecycle (created, subscribed, unsubscribed, attribute and phone/email edits, experiment assignment), scheduled callbacks and reminders, custom tasks, custom objects, and cancel-all-automated-tasks signals. Each event carries a common envelope (userId, traits, name, eventId, properties, originalTimestamp, eventSource) plus event-specific properties. Webhooks must respond within five seconds or the event is dropped (no retries); endpoint changes take up to five minutes to propagate.

Regal Reporting Webhooks is one of 8 APIs that Regal publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Events, Reporting, Streaming, and AsyncAPI. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 0 operations across 40 channels, and defines 29 schemas. It is described by AsyncAPI 3.0.0, at version 1.0.

The API connects through a single server, customer-configured-host (https).

0 operations 40 channels 29 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 3.0.0
API Version
1.0
Server
customer-configured-host (https)

Messages & Schemas 29

The contract defines 29 schemas that model the data carried by its messages. The most detailed is EventEnvelope (7 properties). Each schema is shown below with its type and property counts.

BaseEnvelope
message
AgentActivityUpdated
message
TaskCreated
message
TaskCanceled
message
TaskReservationAccepted
message
TaskReservationCreated
message
CallEvent
message
RecordingEvent
message
TranscriptEvent
message
AnalysisEvent
message
SmsEvent
message
MmsEvent
message
EmailEvent
message
ContactEvent
message
ScheduleEvent
message
TaskEvent
message
CustomObjectEvent
message
EventEnvelope
object
7 properties 2 required
AgentActivityPayload
object
CallPayload
object
RecordingPayload
object
TranscriptPayload
object
AnalysisPayload
object
SmsPayload
object
EmailPayload
object
ContactPayload
object
SchedulePayload
object
TaskPayload
object
CustomObjectPayload
object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

regal-reporting-webhooks-asyncapi.yml Raw ↑

Other APIs Regal publishes across the network.

Regal Branded Phone Numbers API
Regal Business Profiles API
Regal Campaigns API
Regal Dispositions API
Regal Events API
Regal Messages API
Regal Phone Numbers API