Triggers

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.20. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.20, the version this site installs: a call that does not type-check against it fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

GET `/v1/triggers`

GET/v1/triggers

Deprecated

List triggers

const  = await ..("/v1/triggers");

Parameters, body and every documented response: GET /v1/triggers in the HTTP reference.

POST `/v1/triggers`

POST/v1/triggers

Deprecated

Subscribe a webhook to an event

const  = await ..("/v1/triggers", {
  : {
    : "Example",
    : "string",
    : "srv_0000000000000000",
    : "https://example.com/hook",
    : {
      : [
        {
          : "amount_minor",
          : "gt",
          : 1000
        }
      ]
    },
    : {
      : "webhook"
    }
  }
});

Parameters, body and every documented response: POST /v1/triggers in the HTTP reference.

POST `/v1/triggers/deliveries/{delivery_id}/redeliver`

POST/v1/triggers/deliveries/{delivery_id}/redeliver

Deprecated

Queue a delivery to be sent again (deprecated path)

const  = await ..("/v1/triggers/deliveries/{delivery_id}/redeliver", {
  : {
    : "delivery_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/triggers/deliveries/{delivery_id}/redeliver in the HTTP reference.

GET `/v1/triggers/events`

List the event types a trigger can subscribe to

const  = await ..("/v1/triggers/events");

Parameters, body and every documented response: GET /v1/triggers/events in the HTTP reference.

POST `/v1/triggers/retry-pending`

POST/v1/triggers/retry-pending

Deprecated

Drain the retry queue for this project (deprecated path)

const  = await ..("/v1/triggers/retry-pending");

Parameters, body and every documented response: POST /v1/triggers/retry-pending in the HTTP reference.

POST `/v1/triggers/simulate`

Count how many recent events a condition would have matched

const  = await ..("/v1/triggers/simulate", {
  : {
    : "string",
    : {
      : [
        {
          : "amount_minor",
          : "gt",
          : 1000
        }
      ]
    },
    : "24h"
  }
});

Parameters, body and every documented response: POST /v1/triggers/simulate in the HTTP reference.

GET `/v1/triggers/{id}`

GET/v1/triggers/{id}

Deprecated

Read one webhook endpoint (deprecated path)

const  = await ..("/v1/triggers/{id}", {
  : {
    : "trg_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/triggers/{id} in the HTTP reference.

PATCH `/v1/triggers/{id}`

PATCH/v1/triggers/{id}

Deprecated

Update a webhook endpoint (deprecated path)

const  = await ..("/v1/triggers/{id}", {
  : {
    : "trg_0000000000000000"
  },
  : {
    : "Example",
    : "https://example.com/hook",
    : "active",
    : {
      : [
        {
          : "amount_minor",
          : "gt",
          : 1000
        }
      ]
    },
    : {
      : "webhook"
    }
  }
});

Parameters, body and every documented response: PATCH /v1/triggers/{id} in the HTTP reference.

DELETE `/v1/triggers/{id}`

DELETE/v1/triggers/{id}

Deprecated

Delete a webhook endpoint (deprecated path)

const  = await ..("/v1/triggers/{id}", {
  : {
    : "trg_0000000000000000"
  }
});

Parameters, body and every documented response: DELETE /v1/triggers/{id} in the HTTP reference.

GET `/v1/triggers/{id}/deliveries`

GET/v1/triggers/{id}/deliveries

Deprecated

List recent delivery attempts (deprecated path)

const  = await ..("/v1/triggers/{id}/deliveries", {
  : {
    : "trg_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/triggers/{id}/deliveries in the HTTP reference.

GET `/v1/triggers/{id}/deliveries/{delivery_id}`

GET/v1/triggers/{id}/deliveries/{delivery_id}

Deprecated

Inspect one delivery attempt (deprecated path)

const  = await ..("/v1/triggers/{id}/deliveries/{delivery_id}", {
  : {
    : "trg_0000000000000000",
    : "delivery_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/triggers/{id}/deliveries/{delivery_id} in the HTTP reference.

GET `/v1/triggers/{id}/dlq`

GET/v1/triggers/{id}/dlq

Deprecated

List dead lettered deliveries (deprecated path)

const  = await ..("/v1/triggers/{id}/dlq", {
  : {
    : "trg_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/triggers/{id}/dlq in the HTTP reference.

POST `/v1/triggers/{id}/rotate-secret`

POST/v1/triggers/{id}/rotate-secret

Deprecated

Mint a new signing secret for a webhook endpoint (deprecated path)

const  = await ..("/v1/triggers/{id}/rotate-secret", {
  : {
    : "trg_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/triggers/{id}/rotate-secret in the HTTP reference.

POST `/v1/triggers/{id}/test-fire`

POST/v1/triggers/{id}/test-fire

Deprecated

Deliver a synthetic event to a webhook endpoint (deprecated path)

const  = await ..("/v1/triggers/{id}/test-fire", {
  : {
    : "trg_0000000000000000"
  },
  : {
    : "string",
    : {}
  }
});

Parameters, body and every documented response: POST /v1/triggers/{id}/test-fire in the HTTP reference.

On this page