You can create Webhook subscriptions if you belong to the Tenant/Subsciption.
Resources
| Resource Path | Entity for which actions are covered | Actions | |||
|---|---|---|---|---|---|
| "Any" | "Create" | "Update" | "Delete" | ||
tenant/{tenantId}/sidedrawer
|
Drawers with tenantId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/record
|
Folders with sidedrawerId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/record/{recordId}
|
Specific Folder | ✔ | ✔ | ✔ | |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/record/{recordId}/network
|
Collaboration networks with recordId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/record/{recordId}/files
|
Files with sidedrawerId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/inbox
|
Inboxes with sidedrawerId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/network
|
Collaboration networks with sidedrawerId as parent |
✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/plan-request
|
Plan or Item within the Drawer | ✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/plan-request/{planRequestId}
|
An Item | ✔ | ✔ | ✔ | ✔ |
| Specific Plan | ✔ | ✔ | |||
tenant/{tenantId}/sidedrawer/{sidedrawerId}/plan-request/{planRequestId}/item
|
Any Item | ✔ | ✔ | ✔ | ✔ |
tenant/{tenantId}/sidedrawer/{sidedrawerId}/plan-request/{planRequestId}/item/{planItemId}
|
Specific Item | ✔ | ✔ | ✔ | |
tenant/{tenantId}/network/{openId}
|
Collaboration network within a Drawer | ✔ | ✔ | ✔ | ✔ |
subscription/{subscriptionid}/license
|
Licenses with subscriptionId as parent |
✔ | ✔ | ✔ | |
{
"modificationType": "Create",
"notificationUrl": "string",
"resource": "tenant/{tenantId}/sidedrawer",
"expirationDateTime": "2029-07-07T14:40:40-03:00",
"brandCode": "mybrand",
"notificationMessages": "",
"integrityKey": "",
"maxRetries": 0
}
Webhook Subscription entity
modificationType enum required
Modification type. Possible values: create, delete, update, any.
notificationUrl string
Callback URL to send a notification about the change. Must be HTTPS. Required for connectionType = HTTP.
resource string required
The path of the resource to which to be subscribed.
expirationDateTime date-time string required
Webhook expiration date-time.
brandCode string
Branding code.
notificationMessages string
Name of the event to which the client is subscribing. Required for connectionType = SOCKET.
integrityKey string
If sent, the server generates an HMAC SHA256 hash of the event and attaches it in the HTTP request headers as "integrityHash". The value of this field is used for both client-side and server-side encryption/decryption.
maxRetries number
Maximum number of retries allowed.