Common Data

All Webhook payloads contain a set of shared common data and metadata included in every payload.

Header contains: Auth-Token : This is a secret token customized to you that you can use to validate that the request has come from Captain.AI. Your account manager will ask you what you'd like it to be at the point of setting up webhooks. If you wish to change it afterwards, please contact your account manager.

Common Data

JSON Field		Type	Description
event_name		string	Name of the event type
created_at		DateTime	Time event was created
event_uuid		string	Unique identifier for each event on Captain
environment		string	The environment used to send the webhook
metadata	sent_at	DateTime	The time the webhook payload is sent out
metadata	delivery_attempt	integer	The current delivery attempt number

Example Payload with common data

{
  "data": {
    "order_uuid": "1bbccbfff496",
    "partners_unique_internal_order_id": "ac730930-a545-4a54-8ad9-5f60737d8a1c",
    "account_uuid": "1234c9999f79",
    "agent_uuid": "1133bb999a45",
    "agent_partners_external_identifier": "webhook-driver-1-partners-external-identifier",
    "agent_partner_data": {},
    "partners_unique_internal_order_id": "bb61f5f3-af81-4fa1-9281-32f7e8b2d0ed",
    "order_account_partners_external_identifier": "partners-external-identifier-account",
    "order_account_business_partners_external_identifier": "",
    "order_custom_fields": null,
    "published_at": 1651156220.3478127
  },
  "environment": "production",
  "event_name": "order_unassigned",
  "created_at": "2022-04-28T14:30:20.483+00:00",
  "event_uuid": "b3df4834-328b-4d54-a871-91b17aa52ca4",
  "metadata": {
    "sent_at": "2022-04-28T14:30:20.500+00:00",
    "delivery_attempt": 1
  }
}