Skip to content
AI Inbx
Esc
↑↓navigate↵open⌘Jpreview

thread.created

A new conversation started: an inbound message, a send, or a forward.

POSTthread.createdWebhook
Header parameters
AIInbx-Signaturestringrequired

t=<unix seconds>,v1=<hmac>: an HMAC-SHA256 of the timestamp and the raw body, with one v1 per secret while a rotation's grace period runs.

AIInbx-Event-IDstringrequired

The event id, id in the body.

Request body
requiredapplication/json
idstringrequired

The event, evt_…. Stable across retries and replays: deduplicate on it.

matches ^[a-z]+_[0-9a-f]{32}$
typestringrequired
created_atstring<date-time>required

When the event happened.

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
space_idstring | nullrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties
Any of:
string
string
null
null
dataobjectrequired
Show properties
thread_idstringrequired

The new conversation, thr_….

matches ^[a-z]+_[0-9a-f]{32}$
subjectstringrequired

The opening subject.

mailboxstring<email>required

The address on your side.

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
forward_ofstring | nullrequired

Set when a forward opened the thread: the conversation it carries.

Show properties
Any of:
string
string
null
null
Responses
2XX

Acknowledges the delivery. Anything else, or no answer within 10 seconds, is retried; a Retry-After header is honoured over the standard backoff.

Payload
{
  "id": "string",
  "type": "thread.created",
  "created_at": "2019-08-24T14:15:22Z",
  "space_id": "string",
  "data": {
    "thread_id": "string",
    "subject": "string",
    "mailbox": "user@example.com",
    "forward_of": "string"
  }
}
Response
Acknowledges the delivery. Anything else, or no answer within 10 seconds, is retried; a `Retry-After` header is honoured over the standard backoff.