Skip to content

Commit 2214a1f

Browse files
anastasiaberyozaanastasiaberyoza
authored
Add missing Sign webhooks (#878)
* Add missing Sign webhooks * Fix the wording
1 parent 1477efa commit 2214a1f

File tree

2 files changed

+46
-43
lines changed

2 files changed

+46
-43
lines changed

‎content/guides/webhooks/triggers.md‎

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -20,51 +20,54 @@ The following is a list of events that can be configured to trigger a V2
2020
webhook. Some events are only available for files, while others are only
2121
available for folders.
2222

23-
| Event | Triggered | File? | Folder? |
24-
|-----------------------------|---------------------------------------------------------------------------------------------------------------------|-------|---------|
25-
| `COLLABORATION.CREATED` | A collaboration is created. | No | Yes |
26-
| `COLLABORATION.ACCEPTED` | A collaboration is accepted. | No | Yes |
27-
| `COLLABORATION.REJECTED` | A collaboration is rejected. | No | Yes |
28-
| `COLLABORATION.REMOVED` | A collaboration is removed. | No | Yes |
29-
| `COLLABORATION.UPDATED` | A collaboration is updated. | No | Yes |
30-
| `COMMENT.CREATED` | A comment object is created. | Yes | Yes |
31-
| `COMMENT.UPDATED` | A comment object is edited. | Yes | Yes |
32-
| `COMMENT.DELETED` | A comment object is removed. | Yes | Yes |
23+
| Event | Triggered | File? | Folder? |
24+
|-------|-----------|-------|---------|
25+
| `COLLABORATION.CREATED` | A collaboration is created. | No | Yes |
26+
| `COLLABORATION.ACCEPTED` | A collaboration is accepted. | No | Yes |
27+
| `COLLABORATION.REJECTED` | A collaboration is rejected. | No | Yes |
28+
| `COLLABORATION.REMOVED` | A collaboration is removed. | No | Yes |
29+
| `COLLABORATION.UPDATED` | A collaboration is updated. | No | Yes |
30+
| `COMMENT.CREATED` | A comment object is created. | Yes | Yes |
31+
| `COMMENT.UPDATED` | A comment object is edited. | Yes | Yes |
32+
| `COMMENT.DELETED` | A comment object is removed. | Yes | Yes |
3333
| `DOCGEN_DOCUMENT_GENERATION_FAILED` | Doc Gen failed to generate a document. | Yes | No |
3434
| `DOCGEN_DOCUMENT_GENERATION_STARTED` | Doc Gen started to create a document. | Yes | No |
3535
| `DOCGEN_DOCUMENT_GENERATION_SUCCEEDED` | Doc Gen succeeded to create a document. | Yes | No |
36-
| `FILE.UPLOADED` | A file is uploaded or moved to this folder. | No | Yes |
37-
| `FILE.PREVIEWED` | A file is previewed. | Yes | Yes |
38-
| `FILE.DOWNLOADED` | A file is downloaded. | Yes | Yes |
39-
| `FILE.TRASHED` | A file is moved to trash. | Yes | Yes |
40-
| `FILE.DELETED` | A file is permanently deleted. | Yes | Yes |
41-
| `FILE.RESTORED` | A file is restored from trash. | Yes | Yes |
42-
| `FILE.COPIED` | A file is copied. | Yes | Yes |
43-
| `FILE.MOVED` | A file is moved from one folder to another. | Yes | Yes |
44-
| `FILE.LOCKED` | A file is locked. | Yes | Yes |
45-
| `FILE.UNLOCKED` | A file is unlocked. | Yes | Yes |
46-
| `FILE.RENAMED` | A file is renamed. | Yes | Yes |
47-
| `FOLDER.CREATED` | A folder is created | No | Yes |
48-
| `FOLDER.RENAMED` | A folder is renamed. | No | Yes |
49-
| `FOLDER.DOWNLOADED` | A folder is downloaded. | No | Yes |
50-
| `FOLDER.RESTORED` | A folder is restored from trash. | No | Yes |
51-
| `FOLDER.DELETED` | A folder is permanently removed. | No | Yes |
52-
| `FOLDER.COPIED` | A folder is copied. | No | Yes |
53-
| `FOLDER.MOVED` | A folder is moved to a different folder. | No | Yes |
54-
| `FOLDER.TRASHED` | A folder is moved to trash. | No | Yes |
55-
| `METADATA_INSTANCE.CREATED` | A new metadata template instance is associated with a file or folder. | Yes | Yes |
56-
| `METADATA_INSTANCE.UPDATED` | An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder. | Yes | Yes |
57-
| `METADATA_INSTANCE.DELETED` | An existing metadata template instance associated with a file or folder is deleted. | Yes | Yes |
58-
| `SHARED_LINK.DELETED` | A shared link is deleted. | Yes | Yes |
59-
| `SHARED_LINK.CREATED` | A shared link is created. | Yes | Yes |
60-
| `SHARED_LINK.UPDATED` | A shared link is updated. | Yes | Yes |
61-
| `TASK_ASSIGNMENT.CREATED` | A task is created. | Yes | Yes |
62-
| `TASK_ASSIGNMENT.UPDATED` | A task assignment is changed. | Yes | Yes |
63-
| `SIGN_REQUEST.COMPLETED` | A sign request is completed. | Yes | Yes |
64-
| `SIGN_REQUEST.DECLINED` | A sign request is declined. | Yes | Yes |
65-
| `SIGN_REQUEST.EXPIRED` | A sign request is expired. | Yes | Yes |
36+
| `FILE.UPLOADED` | A file is uploaded or moved to this folder. | No | Yes |
37+
| `FILE.PREVIEWED` | A file is previewed. | Yes | Yes |
38+
| `FILE.DOWNLOADED` | A file is downloaded. | Yes | Yes |
39+
| `FILE.TRASHED` | A file is moved to trash. | Yes | Yes |
40+
| `FILE.DELETED` | A file is permanently deleted. | Yes | Yes |
41+
| `FILE.RESTORED` | A file is restored from trash. | Yes | Yes |
42+
| `FILE.COPIED` | A file is copied. | Yes | Yes |
43+
| `FILE.MOVED` | A file is moved from one folder to another. | Yes | Yes |
44+
| `FILE.LOCKED` | A file is locked. | Yes | Yes |
45+
| `FILE.UNLOCKED` | A file is unlocked. | Yes | Yes |
46+
| `FILE.RENAMED` | A file is renamed. | Yes | Yes |
47+
| `FOLDER.CREATED` | A folder is created. | No | Yes |
48+
| `FOLDER.RENAMED` | A folder is renamed. | No | Yes |
49+
| `FOLDER.DOWNLOADED` | A folder is downloaded. | No | Yes |
50+
| `FOLDER.RESTORED` | A folder is restored from trash. | No | Yes |
51+
| `FOLDER.DELETED` | A folder is permanently removed. | No | Yes |
52+
| `FOLDER.COPIED` | A folder is copied. | No | Yes |
53+
| `FOLDER.MOVED` | A folder is moved to a different folder. | No | Yes |
54+
| `FOLDER.TRASHED` | A folder is moved to trash. | No | Yes |
55+
| `METADATA_INSTANCE.CREATED` | A new metadata template instance is associated with a file or folder. | Yes | Yes |
56+
| `METADATA_INSTANCE.UPDATED` | An attribute (value) is updated/deleted for an existing metadata template instance associated with a file or folder. | Yes | Yes |
57+
| `METADATA_INSTANCE.DELETED` | An existing metadata template instance associated with a file or folder is deleted. | Yes | Yes |
58+
| `SHARED_LINK.DELETED` | A shared link is deleted. | Yes | Yes |
59+
| `SHARED_LINK.CREATED` | A shared link is created. | Yes | Yes |
60+
| `SHARED_LINK.UPDATED` | A shared link is updated. | Yes | Yes |
61+
| `TASK_ASSIGNMENT.CREATED` | A task is created. | Yes | Yes |
62+
| `TASK_ASSIGNMENT.UPDATED` | A task assignment is changed. | Yes | Yes |
63+
| `SIGN_REQUEST.COMPLETED` | A sign request is completed. | Yes | Yes |
64+
| `SIGN_REQUEST.DECLINED` | A sign request is declined. | Yes | Yes |
65+
| `SIGN_REQUEST.EXPIRED` | A sign request is expired. | Yes | Yes |
6666
| `SIGN_REQUEST.SIGNER_EMAIL_BOUNCED` | A signer's email is bounced. | Yes | Yes |
67-
| `WEBHOOK.DELETED` | A webhook is deleted. | No | No |
67+
| `SIGN_REQUEST.SIGNER_SIGNED` | A sign request is signed by a particular signer. | Yes | Yes |
68+
| `SIGN_REQUEST.SIGNATURE_REQUESTED` | A signature is requested from a signer. | Yes | Yes |
69+
| `SIGN_REQUEST.ERROR_FINALIZING` | An error occurred while finalizing a sign request. | Yes | Yes |
70+
| `WEBHOOK.DELETED` | A webhook is deleted. | No | No |
6871

6972
<!-- | `SIGN_REQUEST.SIGNER_EMAIL_BOUNCED` | A sign request recipient email notification was not delivered | -->
7073

‎content/pages/sign/40-webhooks/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This is particularly important since the signature requests are asynchronous,
1717
and the signers can interact with them at any time, possibly outside of your
1818
application.
1919

20-
## Sign related events
20+
## Sign-related events
2121

2222
There are Box Sign-related events that can trigger the webhooks. Like most of Box events the listeners are set at the folder or document level.
2323

@@ -31,6 +31,6 @@ Some examples of events that can be listened to are:
3131
- `SIGN_REQUEST.DECLINED`, when a signature request is declined.
3232
- `SIGN_REQUEST.EXPIRED`, when a signature request expires.
3333
- `SIGN_REQUEST.SIGNER_EMAIL_BOUNCED`, when a signer's email is bounced.
34-
- `SIGN_REQUEST.SIGNER_SIGNED`, when the signature request is signed.
34+
- `SIGN_REQUEST.SIGNER_SIGNED`, when the signature request is signed by a particular signer.
3535
- `SIGN_REQUEST.SIGNATURE_REQUESTED`, when the signature is requested from the signer.
3636
- `SIGN_REQUEST.ERROR_FINALIZING`, when the signature request could not be processed.

0 commit comments

Comments
 (0)