Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tryordinal.com/llms.txt

Use this file to discover all available pages before exploring further.

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.
​
type
string
required
The event type (e.g. post.unscheduled).
​
data
object
required
Event-specific payload for this webhook.
​
createdAt
string
required
ISO 8601 timestamp when the webhook event was created.
{
  "type": "post.unscheduled",
  "data": {
    "post": {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "title": "Q4 Product Launch Announcement",
      "channels": ["LinkedIn"],
      "campaign": null,
      "url": "https://app.tryordinal.com/acme/posts/550e8400-e29b-41d4-a716-446655440001",
      "labels": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440400",
          "name": "Marketing",
          "color": "#9333ea",
          "backgroundColor": "#f3e8ff"
        }
      ],
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "acme",
        "name": "Acme Inc"
      },
      "unscheduledBy": {
        "id": "550e8400-e29b-41d4-a716-446655440010",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com"
      },
      "unscheduledAt": "2025-02-26T14:00:00.000Z",
      "linkedIn": {
        "profile": {
          "id": "550e8400-e29b-41d4-a716-446655440002",
          "name": "Acme Inc",
          "detail": "acme-inc"
        },
        "copy": "Excited to announce our new product launch!",
        "assets": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440010",
            "name": "product-photo.jpg",
            "url": "https://cdn.tryordinal.com/assets/product-photo.jpg",
            "mimetype": "image/jpeg",
            "size": 245678,
            "width": 1920,
            "height": 1080,
            "duration": null
          }
        ]
      },
      "x": null
    }
  },
  "createdAt": "2025-02-26T14:00:00.000Z"
}