Webhooks
Guru has created webhooks services for facilitating realtime server to server notifications between Guru and separate services. Guru's Webhooks work by allowing you to subscribe to events which are generated by Guru. You can include the specific url in your subscription to which the events will be delivered as they are generated (i.e. webhooks are a form of "push based" interaction, which makes them reasonably realtime).
In order to receive events, you must have a functioning webserver. If you do not have access to a funtioning webserver, you can build your own webhooks using an iPaaS provider or leverge our Zapier or Workato app directly.
Webhook LimitThe current webhooks subscription limit is allowing individual users to create up to 25 different webhook subscriptions. If you have any questions around our webhook limits, please reach out to [email protected].
List of Guru Events
Below is the list of Guru events you can subscribe to notifications for:
-
alert-readwhen a user clicks on the "I read it" button in an Announcement -
api-token-createda user was issued a User or Collection API Token -
api-token-deleteda user deleted a User or Collection API Token -
board-createda user created a new Board within a Collection -
board-updateda user edited an existing Board within a Collection -
board-to-pdfa user downloads a board as a PDF -
board-deleteda user deleted an existing Board within a Collection -
board-vieweda user viewed an existing Board within a Collection -
card-added-to-boarda user added a card to a board -
card-comment-createda user has commented on a card -
card-comment-deleteda user deleted a comment on a card -
card-comment-reopeneda user reopens a resolved comment on a card -
card-comment-resolveda user resolved a card comment -
card-comment-updateda user edited a card comment -
card-copieda user either copied the content within the card or clicked on the "Card Copied content" button while viewing a card -
card-copied-tracking -
card-createda new card as been published -
card-deleteda card has been archived -
card-favoriteda user clicked the heart icon to add the card to their card favorites list -
card-file-link-vieweda user viewed a link to a file that is uploaded to a card and displayed in the card's file viewer -
card-link-copieda user clicked on the "Card Copy link" button while viewing a card -
card-link-vieweda user viewed a card from the "Card Copy link" button URL -
card-restoreda user restored a card from the archives -
card-sync-link-copieda user copies the link of a synced card -
card-unfavoriteda user removes a card from their card favorites list -
card-shared-to-teama user made a private card to a team shared card or created a new card which is team shared -
card-to-pdfa user downloads a card as a PDF -
card-unfavoriteda user removed a card from their "My Favorite Card" list -
card-unshareda collaborator is removed from a card -
card-updateda user made edits to a card -
card-verifieda user has verified a card -
card-vieweda user clicked & viewed a card -
collection-createda user created a collection -
collection-deleteda user deleted a collection -
collection-exporteda user exports a collection -
draft-createda user created a card draft -
draft-deleteda user deleted a card draft -
login- a user logs into Guru's webapp -
question-answereda user answered a question in the "Ask the Experts" feature -
question-createda user created a question in the "Ask the Experts" feature -
question-deleteda user deleted a question in the "Ask the Experts" feature -
tag-category-createda user created a tag category -
tag-category-deleteda user deleted a tag category -
tag-category-mergeda user merged a tag category with another tag category -
tag-category-updateda user updated a tag category -
tag-createda user created a tag -
tag-deleteda user deleted a tag -
tag-mergeda user merged a tag with another tag -
tag-updateda user updated a tag -
team-member-addedwhen a new user is added to your team -
team-member-removedwhen a user is removed from your team -
usergroup-created- a Group is created -
usergroup-deleted- a Group is deleted -
usergroup-member-added- a user is added to a Group -
usergroup-member-deleted- a user is removed from a Group
Webhook Methods
- Creating a Webhook
- Recieving a Webhook
- Updating a Webhook
- Testing & Monitoring Webhooks
- Deleting a Webhook
Roles & Permissions
The events you have access to are based on your username's Guru Role & Permissions. Please see the chart below to understand what events you can subscribe to directly (Yes indicates the role has access to subscribe to the specified Activity type while No indicates you cannot subscribe the the specified Activity type and will get a 400 error).
| Activity Types | Admin | Collection Owner | Author | Read Only |
|---|---|---|---|---|
| alert-read | Yes | Yes | Yes | No |
| api-token-created | Yes | No | No | No |
| api-token-deleted | Yes | No | No | No |
| board-created | Yes | Yes | Yes | No |
| board-deleted | Yes | Yes | Yes | No |
| board-to-pdf | Yes | Yes | Yes | No |
| board-updated | Yes | Yes | Yes | No |
| board-viewed | Yes | Yes | Yes | No |
| card-to-pdf | Yes | Yes | Yes | No |
| collection-exported | Yes | Yes | Yes | No |
| draft-created | Yes | Yes | Yes | No |
| draft-deleted | Yes | Yes | Yes | No |
| card-added-to-board | Yes | Yes | Yes | Yes |
| card-comment-created | Yes | Yes | Yes | Yes |
| card-comment-deleted | Yes | Yes | Yes | Yes |
| card-comment-reopened | Yes | Yes | Yes | Yes |
| card-comment-resolved | Yes | Yes | Yes | Yes |
| card-comment-updated | Yes | Yes | Yes | Yes |
| card-copied | Yes | Yes | Yes | No |
| card-copied-tracking | Yes | Yes | Yes | No |
| card-created | Yes | Yes | Yes | Yes |
| card-deleted | Yes | Yes | Yes | Yes |
| card-favorited | Yes | Yes | Yes | No |
| card-file-link-copied | Yes | Yes | Yes | No |
| card-file-link-viewed | Yes | Yes | Yes | No |
| card-link-copied | Yes | Yes | Yes | No |
| card-link-viewed | Yes | Yes | Yes | No |
| card-restored | Yes | Yes | Yes | Yes |
| card-shared-to-team | Yes | No | No | No |
| card-sync-link-copied | Yes | Yes | Yes | No |
| card-unfavorited | Yes | Yes | Yes | No |
| card-unshared | Yes | Yes | Yes | No |
| card-updated | Yes | Yes | Yes | Yes |
| card-verification-interval | Yes | Yes | Yes | Yes |
| card-verified | Yes | Yes | Yes | Yes |
| card-viewed | Yes | Yes | Yes | No |
| collection-created | Yes | Yes | Yes | No |
| collection-deleted | Yes | Yes | Yes | No |
| login | Yes | No | No | No |
| question-answered | Yes | Yes | Yes | Yes |
| question-created | Yes | Yes | Yes | Yes |
| question-deleted | Yes | Yes | Yes | Yes |
| tag-category-created | Yes | Yes | Yes | No |
| tag-category-deleted | Yes | Yes | Yes | No |
| tag-category-merged | Yes | Yes | Yes | No |
| tag-category-updated | Yes | Yes | Yes | No |
| tag-created | Yes | Yes | Yes | No |
| tag-deleted | Yes | Yes | Yes | No |
| tag-merged | Yes | Yes | Yes | No |
| tag-updated | Yes | Yes | Yes | No |
| team-member-added | Yes | No | No | No |
| team-member-removed | Yes | No | No | No |
| usergroup-created | Yes | No | No | No |
| usergroup-deleted | Yes | No | No | No |
| usergroup-member-added | Yes | No | No | No |
| usergroup-member-deleted | Yes | No | No | No |
Have any questions? Please email [email protected] for help.
Updated 18 days ago
