Skip to main content
Chirp home page
Search...
⌘K
Support
Dashboard
Dashboard
Search...
Navigation
Playground Async
Playground Async API
Documentation
API Reference
API Reference
API Introduction
Authentication
Errors
Error Codes
Handling Errors
Rate Limits
Application APIs
App Keys
Functions
Webhooks
Phone Numbers
SMS
WhatsApp
WhatsApp Groups
WhatsApp Phone Settings
WhatsApp Templates
Media
Administration APIs
Admin Keys
Billing
Settings
Stats
Apps
Admin Keys
App Keys
App Webhooks
App Phone Numbers
Phone Numbers
SMS
WhatsApp Messages
WhatsApp Business Profiles
WhatsApp Phone Numbers
WhatsApp Templates
Embedded Signup Sessions
Playground Async
WSS
Playground Async API
Messages
sendMessage
{}
refreshAuth
{}
joinRoom
{}
getMessageHistory
{}
authResult
{}
validationError
{}
messageReceived
{}
messageHistory
{}
messageHistoryError
{}
eventLogged
{}
typingIndicator
{}
error
{}
connected
{}
pong
{}
Playground Async
Playground Async API
Copy page
Copy page
WSS
https://api.buildwithchirp.com
http://localhost:3006
Connect
Messages
sendMessage
{}
refreshAuth
{}
joinRoom
{}
getMessageHistory
{}
authResult
{}
validationError
{}
messageReceived
{}
messageHistory
{}
messageHistoryError
{}
eventLogged
{}
typingIndicator
{}
error
{}
connected
{}
pong
{}
Security Schemes
Authorization
type:
httpApiKey
Bearer token for authentication
Bindings
method
type:
string
GET
headers
type:
object
show 2 properties
connection
type:
string
Upgrade
upgrade
type:
string
websocket
query
type:
object
show 3 properties
Send
sendMessage
type:
array
refreshAuth
type:
array
joinRoom
type:
array
getMessageHistory
type:
array
Receive
authResult
type:
array
validationError
type:
array
messageReceived
type:
array
messageHistory
type:
array
messageHistoryError
type:
array
eventLogged
type:
array
typingIndicator
type:
array
error
type:
array
connected
type:
array
pong
type:
array
Complete embedded signup session
Previous