Documentation / Webhooks

Webhooks

Integrate SuitTracker with your other tools using real-time webhook notifications.

Webhooks allow you to receive real-time notifications when specific events occur within SuitTracker. When a triggered event occurs, SuitTracker sends an HTTP POST request with a JSON payload to the URL(s) you have configured.

Configuration

Webhooks can be configured in the Organization Settings under the Webhooks tab.

1 Click Add Webhook.
2 Enter the Webhook URL where you want to receive the notifications.
3 Select the Triggers (events) that should fire this webhook.
4 Click Save Changes.

Payload Format

All webhook requests are sent as JSON with a POST method. The standard payload structure is as follows:

{
  "activity": {
    "id": "string",
    "date": "ISO 8601 timestamp (UTC)"
  },
  "event": {
    "key": "EVENT_TYPE_KEY",
    "name": "Human-readable event name"
  },
  "entity": {
    "id": "string",
    "...": "Additional entity-specific fields"
  },
  "value": "string|null",
  "user": {
    "id": "string"
  } | null
}

Fields Description

• activity: Information about the activity log entry, including a unique ID and timestamp.
• event: The type of event (e.g., CUSTOMER_CREATE).
• entity: The full serialized state of the object that was created or modified.
• value: A supplemental value related to the event, such as a new status or a field name.
• user: The ID of the user who performed the action, if applicable.

Sample Events

Customer Created (`CUSTOMER_CREATE`)

{
  "activity": {
    "id": "12345",
    "date": "2026-07-02T11:30:00Z"
  },
  "event": {
    "key": "CUSTOMER_CREATE",
    "name": "Customer Created"
  },
  "entity": {
    "id": "67890",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "fullName": "John Doe"
  },
  "value": "John Doe",
  "user": { "id": "101" }
}

Order Item Status Change (`ORDER_ITEM_UPDATE_STATUS`)

{
  "activity": {
    "id": "34567",
    "date": "2026-07-02T11:40:00Z"
  },
  "event": {
    "key": "ORDER_ITEM_UPDATE_STATUS",
    "name": "Order Item Status Change"
  },
  "entity": {
    "id": "99999",
    "orderId": "55555",
    "name": "Navy Slim Fit Suit",
    "status": "In Tailoring"
  },
  "value": "In Tailoring",
  "user": { "id": "202" }
}

Text Message Received (`MESSAGE_RECEIVED`)

{
  "activity": {
    "id": "45678",
    "date": "2026-07-02T11:45:00Z"
  },
  "event": {
    "key": "MESSAGE_RECEIVED",
    "name": "Text Message Received"
  },
  "entity": {
    "id": "88888",
    "from": "15551234567",
    "body": "Hi, I'd like to check the status of my order.",
    "direction": "inbound"
  },
  "value": "Hi, I'd like to check the status of my order.",
  "user": null
}

Available Event Keys

The following event keys can be used to filter webhooks in your configuration:

Event Key	Description
CUSTOMER_CREATE	Customer Created
CUSTOMER_DELETE	Customer Deleted
CUSTOMER_UPDATE_DETAILS	Customer Details Update
CUSTOMER_AUTOMATED_MESSAGE_SENT	Customer Automated Message Sent
WEDDING_CREATE	Wedding Created
WEDDING_DELETE	Wedding Deleted
WEDDING_ARCHIVE	Wedding Archived
WEDDING_UPDATE_DETAILS	Wedding Details Update
WEDDING_AUTOMATED_MESSAGE_SENT	Wedding Automated Message Sent
WEDDING_MEMBERSHIP_CREATE	Customer Added To Wedding
WEDDING_MEMBERSHIP_DELETE	Customer Removed From Wedding
WEDDING_MEMBERSHIP_UPDATE_DETAILS	Wedding Membership Update Details
WEDDING_MEMBERSHIP_UPDATE_STATUS	Wedding Customer Status Change
WEDDING_MEMBERSHIP_UPDATE_ATTIRE	Wedding Customer Attire Update
WEDDING_MEMBERSHIP_UPDATE_MEASUREMENTS	Wedding Customer Measurements Update
WEDDING_MEMBERSHIP_UPDATE_PAYMENT_STATUS	Wedding Customer Payment Status Update
ORDER_CREATE	Order Created
ORDER_DELETE	Order Deleted
ORDER_UPDATE	Order Update
ORDER_ITEM_CREATE	Order Item Created
ORDER_ITEM_DELETE	Order Item Deleted
ORDER_ITEM_UPDATE	Order Item Update
ORDER_ITEM_UPDATE_STATUS	Order Item Status Change
ORDER_ITEM_UPDATE_STATUS_META	Order Item Assigned Tailor Change
ORDER_GROUP_CREATE	Order Group Created
ORDER_GROUP_DELETE	Order Group Deleted
ORDER_GROUP_UPDATE	Order Group Updated
MESSAGE_RECEIVED	Text Message Received
ORG_UPDATE_SETTINGS	Setting Change

← Previous Users & Employees