Skip to main content

Triggers

SDK methods for the Triggers module, accessed via soat.triggers. See the Triggers module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.triggers.listTriggers()​

List triggers

  • Method: GET
  • Path: /api/v1/triggers
await soat.triggers.listTriggers({
  query: { /* + optional */ },
});

→ Request & response schema

soat.triggers.createTrigger()​

Create a trigger

  • Method: POST
  • Path: /api/v1/triggers
await soat.triggers.createTrigger({
  body: { name, type, target_type, target_id, /* + optional */ },
});

→ Request & response schema

soat.triggers.getTrigger()​

Get a trigger

  • Method: GET
  • Path: /api/v1/triggers/{trigger_id}
await soat.triggers.getTrigger({
  path: { trigger_id },
});

→ Request & response schema

soat.triggers.updateTrigger()​

Update a trigger

  • Method: PATCH
  • Path: /api/v1/triggers/{trigger_id}
await soat.triggers.updateTrigger({
  path: { trigger_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.triggers.deleteTrigger()​

Delete a trigger

  • Method: DELETE
  • Path: /api/v1/triggers/{trigger_id}
await soat.triggers.deleteTrigger({
  path: { trigger_id },
});

→ Request & response schema

soat.triggers.fireTrigger()​

Fire a trigger

  • Method: POST
  • Path: /api/v1/triggers/{trigger_id}/fire
await soat.triggers.fireTrigger({
  path: { trigger_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.triggers.getTriggerSecret()​

Get trigger secret

  • Method: GET
  • Path: /api/v1/triggers/{trigger_id}/secret
await soat.triggers.getTriggerSecret({
  path: { trigger_id },
});

→ Request & response schema

soat.triggers.rotateTriggerSecret()​

Rotate trigger secret

  • Method: POST
  • Path: /api/v1/triggers/{trigger_id}/rotate-secret
await soat.triggers.rotateTriggerSecret({
  path: { trigger_id },
});

→ Request & response schema

soat.triggers.listTriggerFirings()​

List trigger firings

  • Method: GET
  • Path: /api/v1/trigger-firings
await soat.triggers.listTriggerFirings({
  query: { trigger_id, /* + optional */ },
});

→ Request & response schema

soat.triggers.getTriggerFiring()​

Get a trigger firing

  • Method: GET
  • Path: /api/v1/trigger-firings/{firing_id}
await soat.triggers.getTriggerFiring({
  path: { firing_id },
});

→ Request & response schema