Jump to Content
Home
Guides
API Reference
v1.0
API Reference
v1.0
Home
Guides
API Reference
Webhook Object Model
All
Pages
Start typing to search…
JUMP TO
Introduction
Welcome
Getting started
Authentication
Versioning
Pagination
Error handling
Rate Limiting
Superchat API
Channels
Return a channel
get
List all channels
get
Contacts
Create a contact
post
List all contacts
get
Get a contact list for a contact
get
Delete a contact from a list
del
Get contact lists for a contact
get
Add contact to a contact list
post
Get a contact
get
Update a contact
patch
Delete a contact
del
Get conversations for a contact
get
Search a contact
post
Get a contact list
get
List all contact lists
get
List contacts for a contact list
get
Conversations
List all conversations
get
Get a conversation
get
Update a conversation
patch
Delete a conversation
del
Conversation Exports
Create a conversation export
post
Get a conversation export
get
Custom Attributes
List custom attributes
get
Files
Upload a file
post
List all files
get
Get a file
get
Delete a file
del
Inboxes
List all inboxes
get
Get an inbox
get
Labels
List all labels
get
Get a label
get
Messages
Send a message
post
Fetch message engagement analytics
post
Notes
Delete a note
del
Update a note
put
Get a note
get
List all notes
get
Create a note
post
Templates
List all templates
get
Create a template
post
Fetch template aggregated analytics
get
Get a template
get
Update a template
patch
Delete a template
del
Template Folders
List all template folders
get
Create a template folder
post
Update a template folder
put
Delete a template folder
del
Users
Identify yourself
get
List all users
get
Get a user
get
Webhooks
Webhook Object Model
Manage webhooks
Create a webhook
post
List all webhooks
get
Get a webhook
get
Update a webhook
put
Delete a webhook
del
Powered by
Webhook Object Model
Ask AI
Webhook payloads are the actual objects you will receive on trigger.
