Skip to content
Ordinal
Esc
↑↓navigate↵open⌘Jpreview

post.approval.requested

Fired when someone requests approval from users for a post

SENDpost.approval.requested
Message
application/json
typestring

The event type (e.g. post.approval.requested).

dataobject

Event-specific payload for this webhook.

Show properties
approvalobject

Approval request context for the post.

Show properties
postPostSummary

Post being approved. Contains id, title, and url.

Show properties
idstring<uuid>

Post ID.

titlestring

Post title.

urlstring<uri>

Ordinal post URL.

campaignCampaign

Campaign the post belongs to, if any. Contains id, name, startDate, and endDate.

Show properties
idstring<uuid>

Campaign ID.

namestring

Campaign name.

startDatestring<date-time>

Campaign start, as an ISO 8601 timestamp.

endDatestring<date-time>

Campaign end, as an ISO 8601 timestamp.

workspaceWorkspace

Workspace the post belongs to. Contains id, slug, and name.

Show properties
idstring<uuid>

Workspace ID.

slugstring

Workspace slug.

namestring

Workspace name.

createdApprovalsApprovalRequested[]

New approval requests created by this action. Each item has id, isBlocking, message, dueDate, createdAt, status (Requested), user (approver), and requestedBy (who asked for approval). User objects contain id, firstName, lastName, and email. Dates are ISO 8601 strings where present.

Show properties
Array of ApprovalRequested
idstring<uuid>

Approval ID.

isBlockingboolean

Whether this approval blocks progress until it is granted.

messagestring | null

Message attached to the request. Can be null.

dueDatestring<date-time> | null

Due date for the approval. Null when unset.

createdAtstring<date-time>

When the approval was created.

statusstring

Always Requested.

userobject

User asked to approve.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

requestedByobject

User who asked for approval.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

existingApprovalsApprovalRequested | ApprovalApproved[]

Approvals already on the post before this request. Each item is either a requested approval (status Requested) or an approved one (status Approved). Approved items include approvedAt and approvedBy.

Show properties
Array of ApprovalRequested | ApprovalApproved
One of:
ApprovalRequested
idstring<uuid>

Approval ID.

isBlockingboolean

Whether this approval blocks progress until it is granted.

messagestring | null

Message attached to the request. Can be null.

dueDatestring<date-time> | null

Due date for the approval. Null when unset.

createdAtstring<date-time>

When the approval was created.

statusstring

Always Requested.

userobject

User asked to approve.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

requestedByobject

User who asked for approval.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

ApprovalApproved
idstring<uuid>

Approval ID.

isBlockingboolean

Whether this approval blocked progress until it was granted.

messagestring | null

Message attached to the request. Can be null.

dueDatestring<date-time> | null

Due date for the approval. Null when unset.

createdAtstring<date-time>

When the approval was created.

statusstring

Always Approved.

approvedAtstring<date-time>

When the approver granted approval.

approvedByobject

User who approved.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

requestedByobject

User who originally requested approval.

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

createdAtstring<date-time>

ISO 8601 timestamp when the webhook event was created.

Message
{
  "type": "post.approval.requested",
  "data": {
    "approval": {
      "post": {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "title": "Q4 Product Launch Announcement",
        "url": "https://app.tryordinal.com/acme/posts/550e8400-e29b-41d4-a716-446655440001"
      },
      "campaign": {
        "id": "550e8400-e29b-41d4-a716-446655440003",
        "name": "Launch 2025",
        "startDate": "2025-01-01",
        "endDate": "2025-12-31"
      },
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "acme",
        "name": "Acme Inc"
      },
      "createdApprovals": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440700",
          "isBlocking": true,
          "message": "Please review before we publish.",
          "dueDate": "2025-02-28T17:00:00.000Z",
          "createdAt": "2025-02-26T14:00:00.000Z",
          "status": "Requested",
          "user": {
            "id": "550e8400-e29b-41d4-a716-446655440020",
            "firstName": "Alex",
            "lastName": "Rivera",
            "email": "alex@example.com"
          },
          "requestedBy": {
            "id": "550e8400-e29b-41d4-a716-446655440010",
            "firstName": "Jane",
            "lastName": "Doe",
            "email": "jane@example.com"
          }
        }
      ],
      "existingApprovals": []
    }
  },
  "createdAt": "2025-02-26T14:00:00.000Z"
}