Events

Subscribe to one Audience creation or Study run

Accepts an event name, arguments and webhook delivery with HTTPS url and a Standard Webhooks whsec_ secret. The signed callback challenge must succeed before activation. ttlMs requests a lifetime, capped at 24 hours; null grants the finite server default. cursor must be null: historical event replay is unavailable. Repeating the same authenticated principal, callback, event and arguments refreshes the same subscription.

post/api/v1/events/subscribe

Request

  • Base URL: https://api.getminds.ai
  • URL: https://api.getminds.ai/api/v1/events/subscribe
  • Auth: HTTP bearer

Request body

name'audience.creation.finished' | 'study.run.finished' required
argumentsobject required

Audience: operationId (UUID). Study: studyId and runId (UUIDs). Exact argument schemas are returned by GET /api/v1/events.

ttlMsinteger nullable

Requested lifetime; capped at 86400000 ms. Omitted/null grants the finite default.

cursorunknown

Response

Subscription id, finite refreshBefore, null cursor and truncated=false.

Changes

No recorded changes to this operation across all 1 revision of this API.