v18

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

Triggers

List triggers

Returns a list of Triggers

get/triggers

Query parameters

limitinteger

A limit on the number of triggers 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.

{"stackTrail":"paths:/triggers:get:parameters:2:schema:items","oasType":"schema","type":"unknown"}

Filter the returned triggers by status

Response

Returns a hash with data property that contains an array of up to limit Triggers. 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 (unless for authentication, or internal errors).

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": [
    {
      "name": "my example trigger",
      "description": "A reminder to sign-up to our promotion",
      "created_at": "2023-03-25T17:43:23.654278298Z",
      "updated_at": "2023-03-25T17:43:23.654278298Z",
      "action": {
        "url": "https://example.com/my-own-endpoint",
        "timeout_s": 6.2,
        "retry": {
          "max_num_attempts": 5,
          "delay_s": 10
        }
      },
      "payload": {
        "body": "My Message Payload",
        "content_type": "application/json; charset=utf-8",
        "headers": {
          "X-Custom-Header": "Custom-Value"
        }
      },
      "schedule": {
        "cron": "*/30 * * * * *",
        "timezone": "Etc/UTC",
        "type": "recurring"
      },
      "status": "scheduled",
      "estimated_future_runs": [
        "2023-06-22T18:00:00Z"
      ]
    }
  ]
}