Reference#

Technical reference documentation for Outeract.

Event Types#

Complete list of built-in and custom event types.

Error Codes#

API error codes and their meanings.

Rate Limits#

API rate limits and quotas.

Quick Reference#

HTTP Headers#

HeaderValueRequired
AuthorizationBearer <API_KEY>Yes
X-Outeract-App-IDApplication UUIDJWT only*
Content-Typeapplication/jsonYes

*API keys are already scoped to an application, so this header is not needed for API key authentication.

API Endpoints#

APIEndpointAuth
GraphQLhttps://api.outeract.com/API Key
RESThttps://api.outeract.com/v1/API Key
Adminhttps://api.outeract.com/admin/graphqlJWT

Platform Names#

EnumDisplay Name
WHATSAPPWhatsApp Business
INSTAGRAMInstagram Business
FACEBOOKFacebook Messenger
TELEGRAMTelegram
SLACKSlack
DISCORDDiscord
SMSTwilio SMS
EMAILMaileroo Email
IMESSAGEiMessage

Event Statuses#

StatusDescription
pendingAwaiting processing
processingCurrently being processed
completedSuccessfully processed
failedProcessing failed

Message Statuses#

StatusDescription
sentSent to platform
deliveredDelivered to recipient
readRead by recipient
failedDelivery failed

Webhook Types#

TypeDescriptionPlatforms
SHAREDSingle URL for all connectionsWhatsApp, Instagram, Facebook
DEDICATEDUnique URL per connectionTelegram, Slack, Discord, SMS, Email, iMessage

Date Formats#

All dates use ISO 8601 format:

2024-01-15T10:30:00Z

UUID Format#

xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Phone Number Format (E.164)#

+[country code][number]

Examples:

  • US: +14155551234
  • UK: +442071234567
  • Germany: +4915112345678

SDK Reference#

Coming soon:

  • Python SDK
  • Node.js SDK
  • Go SDK
Backward Custom Events Event Types Forward