Triggers

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check 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 { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/triggers

List triggers

const result = await cs.api.get("/v1/triggers");

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

POST /v1/triggers

Subscribe a webhook to an event

const result = await cs.api.post("/v1/triggers", {
  body: {
    name: "Example",
    event: "string",
    server_id: "srv_0000000000000000",
    webhook_url: "https://example.com/hook"
  }
});

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

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

Queue a delivery to be sent again (deprecated path)

const result = await cs.api.post("/v1/triggers/deliveries/{delivery_id}/redeliver", {
  path: {
    delivery_id: "delivery_0000000000000000"
  }
});

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

POST /v1/triggers/retry-pending

Drain the retry queue for this project (deprecated path)

const result = await cs.api.post("/v1/triggers/retry-pending");

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

GET /v1/triggers/{id}

Read one webhook endpoint (deprecated path)

const result = await cs.api.get("/v1/triggers/{id}", {
  path: {
    id: "trg_0000000000000000"
  }
});

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

DELETE /v1/triggers/{id}

Delete a webhook endpoint (deprecated path)

const result = await cs.api.delete("/v1/triggers/{id}", {
  path: {
    id: "trg_0000000000000000"
  }
});

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

GET /v1/triggers/{id}/deliveries

List recent delivery attempts (deprecated path)

const result = await cs.api.get("/v1/triggers/{id}/deliveries", {
  path: {
    id: "trg_0000000000000000"
  }
});

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

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

Inspect one delivery attempt (deprecated path)

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

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

GET /v1/triggers/{id}/dlq

List dead lettered deliveries (deprecated path)

const result = await cs.api.get("/v1/triggers/{id}/dlq", {
  path: {
    id: "trg_0000000000000000"
  }
});

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

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

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

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

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