Skip to main content
GET
/
v1
/
webhooks
/
{webhookId}
Read Webhook
curl --request GET \
  --url https://{tenant}.mindbridge.ai/api/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "name": "<string>",
  "url": "<string>",
  "technicalContactId": "<string>",
  "events": [],
  "publicKey": "<string>",
  "keyGenerationTimestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
webhookId
string
required

Response

200 - application/json

OK

​
id
string

The unique object identifier.

​
version
integer<int64>

Indicates the data integrity version to ensure data consistency.

​
creationDate
string<date-time>
​
lastModifiedDate
string<date-time>
​
createdUserInfo
User Info · object
read-only
​
lastModifiedUserInfo
User Info · object
read-only
​
name
string

The name of the webhook.

​
url
string

The URL to which the webhook will send notifications.

​
technicalContactId
string

A reference to an administrative user used to inform system administrators of issues with the webhooks.

​
events
enum<string>[]

A list of events that will trigger this webhook.

Available options:
EXPORT_READY,
FILE_MANAGER_FILE_ADDED,
DATA_ADDED,
INGESTION_COMPLETE,
INGESTION_FAILED,
ANALYSIS_COMPLETE,
ANALYSIS_FAILED,
UNMAPPED_ACCOUNTS,
ENGAGEMENT_CREATED,
ENGAGEMENT_UPDATED,
ENGAGEMENT_DELETED,
ANALYSIS_CREATED,
ANALYSIS_UPDATED,
ANALYSIS_DELETED,
ANALYSIS_ARCHIVED,
ANALYSIS_UNARCHIVED,
USER_INVITED,
USER_STATUS_UPDATED,
USER_ROLE_UPDATED,
USER_DELETED,
USER_LOGIN
​
publicKey
string

The public key used to verify the webhook signature.

​
status
enum<string>

The current status of the webhook.

Available options:
ACTIVE,
INACTIVE
​
keyGenerationTimestamp
string<date-time>