mulaichatDocs
GuidesDeveloperAPI ReferenceChangelog
Webhooks
POST
/v1/webhooks

At most 10. The URL must be https on port 443 and a public host (400 webhook_url_not_allowed). profile_id limits it to one profile. The signing secret is returned only here.

Requires the write scope. Owner key or session only: a profile key gets 403 owner_key_required.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2000
events*array<>
Items1 <= items
profile_id?string
Length1 <= length <= 128

Response Body

The endpoint with its secret.

application/json
  1. response
id*string
Formatuuid
url*string
events*array<>
profile_id*|

null: events of every profile.

active*boolean
failure_count*integer
disabled_at*|null
created_at*string
Formatdate-time
secret*string

Signing secret, shown only once.

Example Request
curl -X POST 'https://api.mulaichat.com/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "events": [    "account.connected"  ]}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "string",  "events": [    "account.connected"  ],  "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",  "active": true,  "failure_count": 0,  "disabled_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "secret": "string"}

On this page