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. Inline comments attach to specific text in a post—this event fires for each new comment or reply in a thread.
​
type
string
required
The event type (e.g. post.inline_comment.created).
​
data
object
required
Event-specific payload for this webhook.
​
createdAt
string
required
ISO 8601 timestamp when the webhook event was created.
{
  "type": "post.inline_comment.created",
  "data": {
    "comment": {
      "thread": {
        "id": "550e8400-e29b-41d4-a716-446655440060",
        "channel": "LinkedIn",
        "highlightedText": "coming next week",
        "resolved": false,
        "createdAt": "2025-02-26T16:05:00.000Z",
        "updatedAt": null
      },
      "id": "550e8400-e29b-41d4-a716-446655440051",
      "message": "Can we change this to 'launching soon'?",
      "post": {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "title": "Q4 Product Launch Announcement",
        "url": "https://app.tryordinal.com/acme/posts/550e8400-e29b-41d4-a716-446655440001"
      },
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "acme",
        "name": "Acme Inc"
      },
      "createdBy": {
        "id": "550e8400-e29b-41d4-a716-446655440010",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com"
      },
      "createdAt": "2025-02-26T16:05:00.000Z"
    }
  },
  "createdAt": "2025-02-26T16:05:00.000Z"
}