Runs

Get a trigger run

Retrieve details about a specific trigger run. {trigger-name} can be replaced with wildcard - if you only know the run-id.

get/triggers/{trigger-name}/runs/{run-id}

Response

idstring

A unique identifier generated by the server to identify a particular run of the trigger.

created_atstring date-time

RFC3339 datetime indicating when the run was created.

status'attempting' | 'succeeded' | 'failed'

The status of the run. An attempting run means that it's still in-progress, there are possibly one or more delivery attempts linked to this run. Both succeeded and failed are terminal states.

Example response

{
  "id": "run_063001H1Y9BH9FJNHZNHGH4NVD1RXQ",
  "created_at": "2023-03-25T17:43:23.654278298Z",
  "action": {
    "url": "https://example.com/my-own-endpoint",
    "http_method": "POST",
    "timeout_s": 6.2,
    "type": "webhook",
    "retry": {
      "max_num_attempts": 5,
      "delay_s": 10,
      "type": "simple"
    }
  },
  "status": "succeeded",
  "payload": {
    "body": "My Message Payload",
    "content_type": "application/json; charset=utf-8",
    "headers": {
      "X-Custom-Header": "Custom-Value"
    }
  }
}

Changes

Changed in 2 of the 18 revisions of this API.19

Jul 14, 2023v104b2830723581See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 14, 2023v18adff51de02f18See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  removed Run subschema #2 from the response body allOf list for the response status 200
  response-body-all-of-removed
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the optional property action to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property latest_attempt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property payload to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 200 status
  response-optional-property-added

Full history