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.
Event Types
errorMessages
anyOf
The (partial) error messages given by the auto approval process.
item
object
Optional3 Items
message
null
string
reason
string
The reason the request was not automatically approved.
reasonLabel
null
string
The reason the request was not automatically approved, as a human readable string in few words.
reasonText
string
The reason the request was not automatically approved, as a human readable string.
request
object
12 Items
successMessages
anyOf
The (partial) success messages given by the auto approval process.
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."
]
}message
null
string
boolean
Optionalrequest
object
12 Items
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"
}
}isRetry
boolean
Whether this is a retry of a previous request.
item
object
Optional3 Items
request
object
12 Items
shared
object
1 Items
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"
}
}account
object
10 Items
pageUrl
string
(uri)
The url Account Members can visit to see 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"
},
"pageUrl": "https://trust.mycompany.com/3e017e31-b1cf-45f7-afe4-68fccb48a4e0/share"
}account
object
10 Items
from
object
1 Items
orgMem
object
Optional8 Items
pageUrl
string
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"
}account
object
10 Items
accountMember
object
3 Items
orgMem
object
5 Items
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"
}
}account
object
10 Items
accountMember
object
3 Items
string
The email of the account member's invited colleague.
message
string
OptionalThe message sent to the account member's invited colleague.
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"
}account
object
10 Items
accountMember
object
Optional4 Items
nda
object
4 Items
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
}
}entry
object
6 Items
orgMem
object
5 Items
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"
}
}newEntry
object
6 Items
oldEntry
object
6 Items
orgMem
object
5 Items
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"
}
}orgMem
object
5 Items
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"
}
}orgMem
object
5 Items
userId
string
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"
}account
object
10 Items
accountMember
object
Optional4 Items
comment
object
5 Items
direction
string
item
object
5 Items
orgMem
object
Optional8 Items
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"
}
}account
object
Optional10 Items
accountMember
object
Optional4 Items
encryptedType
string
The encryption type that is applied to this file (defaults to none).
engagedAt
string
(date-time)
The date and time the file was engaged.
fileId
string
The downloaded file's SafeBase id.
fileName
string
The downloaded file's name.
item
object
5 Items
shared
object
1 Items
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"
}
}account
object
Optional10 Items
accountMember
object
Optional4 Items
encryptedType
string
The encryption type that is applied to this file (defaults to none).
engagedAt
string
(date-time)
The date and time the file was engaged.
fileId
string
The downloaded file's SafeBase id.
fileName
string
The downloaded file's name.
item
object
5 Items
shared
object
1 Items
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"
}
}account
object
10 Items
accountMember
object
Optional4 Items
orgMem
object
Optional8 Items
qnrInput
object
8 Items
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"
}
}account
object
Optional10 Items
accountMember
object
Optional4 Items
shared
object
1 Items
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"
}
}account
object
10 Items
accountMember
object
Optional4 Items
href
string
orgMem
object
Optional8 Items
qnrInput
object
8 Items
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"
}
}account
object
10 Items
accountMember
object
Optional4 Items
href
string
orgMem
object
Optional8 Items
qnrInput
object
8 Items
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"
}
}account
object
10 Items
accountMember
object
Optional4 Items
href
string
orgMem
object
Optional8 Items
qnrInput
object
8 Items
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"
}
}