SafeBase Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
accessRequest.autoApprove.requireManual
Sent when an access request could not be automatically approved by our system and thus requires additional input to determine whether it should be approved or denied.
Example
JSON
{
"errorMessages": [
"Something happened while processing"
],
"item": {
"kind": "reports",
"productId": "default",
"productSlug": "default",
"title": "SOC2",
"uid": "b3817906-d0ca-4278-af1f-021977becfb1"
},
"message": "Something happened while processing",
"reason": "error",
"reasonLabel": "Error",
"reasonText": "Something happened while processing.",
"request": {
"company": "Other Company",
"country": null,
"createdAt": "1998-11-08T04:17:15+00:00",
"createdAtFormatted": "November 11 1998 4:17:15AM",
"email": "someone@othercompany.com",
"firstName": "Some",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da41",
"lastName": "One",
"productId": "default",
"relationship": null,
"source": null,
"status": "pending"
},
"successMessages": [
"Everything is fine."
]
}accessRequest.blocked
Sent when an access request was automatically blocked by a configuration. In most cases this means an internal user or a competitor requested access.
Example
JSON
{
"message": "Something happened while processing",
"request": {
"company": "Other Company",
"country": null,
"createdAt": "1998-11-08T04:17:15+00:00",
"createdAtFormatted": "November 11 1998 4:17:15AM",
"email": "someone@othercompany.com",
"firstName": "Some",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da41",
"lastName": "One",
"productId": "default",
"relationship": null,
"source": null,
"status": "pending"
}
}accessRequest.requested
Sent when an access request was submitted. This event does not indicate whether it was approved, blocked or pending.
Example
JSON
{
"isRetry": false,
"item": {
"kind": "reports",
"productId": "default",
"productSlug": "default",
"title": "SOC2",
"uid": "b3817906-d0ca-4278-af1f-021977becfb1"
},
"request": {
"company": "Other Company",
"country": null,
"createdAt": "1998-11-08T04:17:15+00:00",
"createdAtFormatted": "November 11 1998 4:17:15AM",
"email": "someone@othercompany.com",
"firstName": "Some",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da41",
"lastName": "One",
"productId": "default",
"relationship": null,
"source": null,
"status": "pending"
},
"shared": {
"mode": "main"
}
}accounts.created
Sent when a new Account is created.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"pageUrl": "https://trust.mycompany.com/3e017e31-b1cf-45f7-afe4-68fccb48a4e0/share"
}accounts.edited
When an account is changed.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"from": {
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
}
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"pageUrl": "https://trust.mycompany.com/3e017e31-b1cf-45f7-afe4-68fccb48a4e0/share"
}accounts.members.added
Sent when a new member is added to an Account.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
}
}accounts.members.colleagueInvited
Sent when an account member invites a colleague to access your Trust Center.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"message": "Something happened while processing"
}accounts.nda.completed
Sent when an Account completed their NDA.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"nda": {
"content": "This is the textual content of the NDA, possibly in **Markdown**.",
"provider": "clickwrap",
"signedAt": "2021-05-05T15:00:00.000Z",
"version": 3
}
}knowledgebase.entry.created
Sent when a new entry is created in your knowledge base.
Example
JSON
{
"entry": {
"accessLevel": "public",
"answer": "We are all about them.",
"comment": "As a remote first company, the home is the office.",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da42",
"productIds": [
"--global--"
],
"question": "What is your policy on office dogs?"
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
}
}knowledgebase.entry.updated
Sent when an entry is created in your knowledge base is updated.
Example
JSON
{
"newEntry": {
"accessLevel": "public",
"answer": "We are all about them.",
"comment": "As a remote first company, the home is the office.",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da42",
"productIds": [
"--global--"
],
"question": "What is your policy on office dogs?"
},
"oldEntry": {
"accessLevel": "public",
"answer": "We are all about them.",
"comment": "As a remote first company, the home is the office.",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da42",
"productIds": [
"--global--"
],
"question": "What is your policy on office dogs?"
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
}
}organization.members.added
Sent when an organization member is added.
Example
JSON
{
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
}
}organization.members.suspended
Sent when an organization member is suspended.
Example
JSON
{
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"userId": "samlp|mycompany|person@mycompany.com"
}portal.conversation.commented
Sent when someone comments on any card in your Trust Center.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"comment": {
"commentedAt": "1998-11-08T04:17:15+00:00",
"commentedAtFormatted": "November 11 1998 4:17:15AM",
"content": "Comment Content here",
"id": "f34e7aa6-798f-4ec4-acb6-5e40e160da41",
"number": 1
},
"direction": "member",
"item": {
"kind": "reports",
"productId": "default",
"productSlug": "default",
"title": "SOC2",
"uid": "b3817906-d0ca-4278-af1f-021977becfb1"
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
}
}portal.file.downloaded
Sent when someone downloads a file on your Trust Center.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"encryptedType": "none",
"engagedAt": "2021-05-05T15:00:00.000Z",
"fileId": "aef05342-5bee-4751-897e-a1f8030d96b9",
"fileName": "file_name.pdf",
"item": {
"kind": "reports",
"productId": "default",
"productSlug": "default",
"title": "SOC2",
"uid": "b3817906-d0ca-4278-af1f-021977becfb1"
},
"shared": {
"mode": "main"
}
}portal.file.viewed
Sent when someone views a file directly on your Trust Center.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"encryptedType": "none",
"engagedAt": "2021-05-05T15:00:00.000Z",
"fileId": "aef05342-5bee-4751-897e-a1f8030d96b9",
"fileName": "file_name.pdf",
"item": {
"kind": "reports",
"productId": "default",
"productSlug": "default",
"title": "SOC2",
"uid": "b3817906-d0ca-4278-af1f-021977becfb1"
},
"shared": {
"mode": "main"
}
}portal.questionnaire.submittedDeprecated
Sent when a questionnaire is submitted in your Trust Center, this can be submitted by an account member, or an organization member.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"qnrInput": {
"contentType": "application/pdf",
"createdAt": "1978-06-26T12:00:36+00:00",
"createdAtFormatted": "June 26 1978 12:00:36PM",
"originalName": "uploaded_file_name.pdf",
"qnrId": "981db787-1f2b-4372-89a5-941df92b5f64",
"size": "41832",
"type": "file",
"uploaderName": "Some One",
"uploaderType": "account_member"
}
}portal.viewed
Sent when someone views any product on your Trust Center.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"shared": {
"mode": "main"
}
}questionnaire.completed
Sent when a questionnaire is marked as completed.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"href": "https://app.safebase.io/questionnaires/981db787-1f2b-4372-89a5-941df92b5f64",
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"qnrInput": {
"contentType": "application/pdf",
"createdAt": "1978-06-26T12:00:36+00:00",
"createdAtFormatted": "June 26 1978 12:00:36PM",
"originalName": "uploaded_file_name.pdf",
"qnrId": "981db787-1f2b-4372-89a5-941df92b5f64",
"size": "41832",
"type": "file",
"uploaderName": "Some One",
"uploaderType": "account_member"
}
}questionnaire.inProgress
Sent when a questionnaire review has started.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"href": "https://app.safebase.io/questionnaires/981db787-1f2b-4372-89a5-941df92b5f64",
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"qnrInput": {
"contentType": "application/pdf",
"createdAt": "1978-06-26T12:00:36+00:00",
"createdAtFormatted": "June 26 1978 12:00:36PM",
"originalName": "uploaded_file_name.pdf",
"qnrId": "981db787-1f2b-4372-89a5-941df92b5f64",
"size": "41832",
"type": "file",
"uploaderName": "Some One",
"uploaderType": "account_member"
}
}questionnaire.uploaded
Sent when a questionnaire is uploaded.
Example
JSON
{
"account": {
"createdAt": "2021-05-05T15:00:00.000Z",
"createdByUserId": "samlp|mycompany|person@mycompany.com",
"domains": [
"othercompany.com"
],
"expiresAt": null,
"id": "06b7ad99-ba06-4789-9e8c-61f56e4a1b91",
"name": "Other Company",
"ndaProvider": "clickwrap",
"permissionProfileId": "3030547f-2e96-4953-be9d-6f52b5eef39b",
"reviewStatus": "not_started",
"sfdcAccountId": "0010Y00001XWQ2UQAX"
},
"accountMember": {
"email": "someone@othercompany.com",
"firstName": "Some",
"lastName": "One"
},
"href": "https://app.safebase.io/questionnaires/981db787-1f2b-4372-89a5-941df92b5f64",
"orgMem": {
"createdAt": "2021-05-05T15:00:00.000Z",
"role": "admin",
"suspendedAt": "2021-05-05T15:30:00.000Z",
"type": "member",
"userId": "samlp|mycompany|person@mycompany.com"
},
"qnrInput": {
"contentType": "application/pdf",
"createdAt": "1978-06-26T12:00:36+00:00",
"createdAtFormatted": "June 26 1978 12:00:36PM",
"originalName": "uploaded_file_name.pdf",
"qnrId": "981db787-1f2b-4372-89a5-941df92b5f64",
"size": "41832",
"type": "file",
"uploaderName": "Some One",
"uploaderType": "account_member"
}
}