- Accounts
- Account Users
- AgentBots
- Users
- Inbox API
- Contacts API
- Conversations API
- Messages API
- Contact Labels
- CSAT Survey Page
- Account AgentBots
- Agents
- Canned Responses
- Canned Response
- Custom Attributes
- Contacts
- Contact
- Automation Rule
- Help Center
- Conversations
- Conversation Assignment
- Conversation Labels
- Inboxes
- Messages
- Integrations
- Profile
- Teams
- Custom Filters
- Webhooks
- Reports
- Platform - Conversations
- Platform Documents
- Macros
- Paths
- Ticketing Issue Types
- Ticketing Custom Fields
- Ticketing Status Workflows
- Ticketing Issues
- Ticketing Comments
- Aily Assistants
- Aily Assistant Inboxes
- Aily Assistant Responses
- Aily Bulk Actions
- Aily Copilot Threads
- Aily Copilot Messages
- Aily Documents
- Aily Collections
- SLA Policies
- Custom Roles
- Meetings
- Campaigns
- MCP Servers
- Assistant MCP Servers
- Dashboard Apps
- Schemas
- Schemas
- data
- request_error
- generic_id
- canned_response
- custom_attribute
- automation_rule
- portal
- category
- article
- contact
- conversation
- message
- user
- agent
- inbox
- agent_bot
- contact_inboxes
- macro
- contactable_inboxes
- custom_filter
- webhook
- account
- platform_account
- team
- integrations_app
- integrations_hook
- public_contact
- public_conversation
- path
- public_message
- public_inbox
- account_create_update_payload
- agent_bot_create_update_payload
- user_create_update_payload
- canned_response_create_update_payload
- custom_attribute_create_update_payload
- macro_create_update_payload
- contact_create
- contact_update
- conversation_message_create
- team_create_update_payload
- custom_filter_create_update_payload
- webhook_create_update_payload
- integrations_hook_create_payload
- integrations_hook_update_payload
- automation_rule_create_update_payload
- portal_create_update_payload
- category_create_update_payload
- article_create_update_payload
- public_contact_create_update_payload
- public_message_create_payload
- public_message_update_payload
- public_conversation_create_payload
- extended_contact
- contact_base
- contact_list
- contact_conversations
- contact_labels
- conversation_list
- conversation_show
- conversation_status_toggle
- conversation_labels
- account_summary
- agent_conversation_metrics
- platform_documents_create_payload
- platform_documents_create_response
- platform_documents_list_response
- platform_documents_show_response
- platform_documents_update_payload
- platform_documents_update_response
- platform_documents_delete_payload
- platform_documents_delete_response
Create an integration hook
Develop Env
http://localhost:3030
Develop Env
http://localhost:3030
POST
/api/v1/accounts/{account_id}/integrations/hooks
Request
Authorization
API Key
Add parameter in header
api_access_token
Example:
api_access_token: ********************or
Path Params
Body Params application/json; charset=utf-8Required
Examples
Responses
🟢200OK
application/json; charset=utf-8
Body
🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:3030/api/v1/accounts//integrations/hooks' \
--header 'api_access_token: <api-key>' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
"app_id": "string",
"inbox_id": "string",
"settings": {}
}'Response Response Example
{
"id": "string",
"app_id": "string",
"inbox_id": "string",
"account_id": "string",
"status": true,
"hook_type": true,
"settings": {}
}Modified at 2025-12-16 21:28:58