v18

latestOpenAPI 3.1.0raw.githubusercontent.com2023-07-1410950.6 KB

Runs

List recent runs for a trigger

Returns a list of of the recent runs for a given trigger

get/triggers/{trigger-name}/runs

Query parameters

limitinteger

A limit on the number of runs to be returned. Limit can be a number between 1 and 100. Default limit is 20.

cursorstring

A cursor for use in pagination. cursor defines your place in the list.

Response

Returns a hash with data property that contains an array of up to limit runs of a particular trigger. The cursor parameter defines the starting point for the returned page.

Objects returned are sorted in reverse chronological orders (most recently created comes first).

This API will not fail with 404 if the trigger does not exist.

has_moreboolean

has_more is true if limit was reached before returning all results.

next_cursorstring nullable

The cursor string that can be used to fetch the next page in this iterator.

Example response

{
  "data": [
    {
      "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"
        }
      }
    }
  ]
}