Sign in
Automations

Trigger automation

Triggers webhook-invoked automation

post/docs/{docId}/hooks/automation/{ruleId}

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/docs/{docId}/hooks/automation/{ruleId}
  • Auth: HTTP bearer

Path parameters

docIdstring required

ID of the doc.

ruleIdstring required

ID of the automation rule.

Request body

WebhookTriggerPayload required

Payload for webhook trigger

Example request

{
  "message": "The doc that brings words, data, & teams together."
}

Response

A result indicating that the automation trigger was queued for processing.

requestIdstring required

An arbitrary unique identifier for this request.

Example response

{
  "requestId": "abc-123-def-456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.