Webhooks - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

WEBHOOK

Example

{
  "eventId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "senderId": "<string>",
  "tenantId": "<string>",
  "userId": "<string>",
  "data": {
    "eventId": "<string>",
    "analysisId": "<string>",
    "analysisResultId": "<string>",
    "engagementId": "<string>"
  }
}

Authorizations

Authorization

• string
• header
• required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

• webhook-id
  • string
  • required

A unique event ID for the event that triggered the outbound webhook request.

• webhook-timestamp
  • integer<int32>
  • required

Timestamp associated with the outbound HTTPS request.

• webhook-signature
  • string
  • required

The digital signature that can be used to validate the authenticity of the webhook data.

Body

application/json

• Option 1

• Option 2

• Option 3

• Option 4

• Option 5

• Option 6

• Option 7

• Option 8

• Option 9

• Option 10

• type

  • enum<string>

The event type that triggered the webhook.

Available options:

• analysis.completed,

• analysis.failed

• eventId

  • string

The ID of the event that triggered the outbound request.

• timestamp
  • string<date-time>

The time that the webhook was triggered.

• senderId
  • string

The ID of the registered webhook configuration that initiated the outbound request.

• tenantId
  • string

The name of the tenant that triggered the webhook.

• userId
  • string

The ID of the user that initiated the event that triggered the webhook.

• data
  • object

The data associated with the webhook event.