Guru

Guru Developer Network

Welcome to the Guru Developer Network. You'll find comprehensive guides with API documentation to help you start building with Guru. Let's jump right in!

Guides    API Reference

Getting Started with Guru's Webhook Services

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 Limit

The 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 sup[email protected]

List of Guru Events

Below is the list of Guru events you can subscribe to notifications for:

  • alert-read when a user clicks on the "I read it" button in a Knowledge Alert

  • api-token-created a user was issued a User or Collection API Token

  • api-token-deleted a user deleted a User or Collection API Token

  • board-created a user created a new Board within a Collection

  • board-updated a user edited an existing Board within a Collection

  • board-to-pdf a user downloads a board as a PDF

  • board-deleted a user deleted an existing Board within a Collection

  • board-viewed a user viewed an existing Board within a Collection

  • card-added-to-board a user added a card to a board

  • card-comment-created a user has commented on a card

  • card-comment-deleted a user deleted a comment on a card

  • card-comment-reopened a user reopens a resolved comment on a card

  • card-comment-resolved a user resolved a card comment

  • card-comment-updated a user edited a card comment

  • card-copied a user either copied the content within the card or clicked on the "Card Copied content" button while viewing a card

  • card-copied-tracking

  • card-created a new card as been published

  • card-deleted a card has been archived

  • card-favorited a user clicked the heart icon to add the card to their card favorites list

  • card-file-link-viewed a user viewed a link to a file that is uploaded to a card and displayed in the card's file viewer

  • card-link-copied a user clicked on the "Card Copy link" button while viewing a card

  • card-link-viewed a user viewed a card from the "Card Copy link" button URL

  • card-restored a user restored a card from the archives

  • card-sync-link-copied a user copies the link of a synced card

  • card-unfavorited a user removes a card from their card favorites list

  • card-shared-to-team a user made a private card to a team shared card or created a new card which is team shared

  • card-to-pdf a user downloads a card as a PDF

  • card-unfavorited a user removed a card from their "My Favorite Card" list

  • card-unshared a collaborator is removed from a card

  • card-updated a user made edits to a card

  • card-verified a user has verified a card

  • card-viewed a user clicked & viewed a card

  • collection-created a user created a collection

  • collection-deleted a user deleted a collection

  • collection-exported a user exports a collection

  • draft-created a user created a card draft

  • draft-deleted a user deleted a card draft

  • login - a user logs into Guru's webapp

  • question-answered a user answered a question in the "Ask the Experts" feature

  • question-created a user created a question in the "Ask the Experts" feature

  • question-deleted a user deleted a question in the "Ask the Experts" feature

  • tag-category-created a user created a tag category

  • tag-category-deleteda user deleted a tag category

  • tag-category-merged a user merged a tag category with another tag category

  • tag-category-updated a user updated a tag category

  • tag-created a user created a tag

  • tag-deleted a user deleted a tag

  • tag-merged a user merged a tag with another tag

  • tag-updated a user updated a tag

  • team-member-added when a new user is added to your team

  • team-member-removed when 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

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 TypesAdminCollection OwnerAuthorRead Only
alert-readYesYesYesNo
api-token-createdYesNoNoNo
api-token-deletedYesNoNoNo
board-createdYesYesYesNo
board-deletedYesYesYesNo
board-to-pdfYesYesYesNo
board-updatedYesYesYesNo
board-viewedYesYesYesNo
card-to-pdfYesYesYesNo
collection-exportedYesYesYesNo
draft-createdYesYesYesNo
draft-deletedYesYesYesNo
card-added-to-boardYesYesYesYes
card-comment-createdYesYesYesYes
card-comment-deletedYesYesYesYes
card-comment-reopenedYesYesYesYes
card-comment-resolvedYesYesYesYes
card-comment-updatedYesYesYesYes
card-copiedYesYesYesNo
card-copied-trackingYesYesYesNo
card-createdYesYesYesYes
card-deletedYesYesYesYes
card-favoritedYesYesYesNo
card-file-link-copiedYesYesYesNo
card-file-link-viewedYesYesYesNo
card-link-copiedYesYesYesNo
card-link-viewedYesYesYesNo
card-restoredYesYesYesYes
card-shared-to-teamYesNoNoNo
card-sync-link-copiedYesYesYesNo
card-unfavoritedYesYesYesNo
card-unsharedYesYesYesNo
card-updatedYesYesYesYes
card-verification-intervalYesYesYesYes
card-verifiedYesYesYesYes
card-viewedYesYesYesNo
collection-createdYesYesYesNo
collection-deletedYesYesYesNo
loginYesNoNoNo
question-answeredYesYesYesYes
question-createdYesYesYesYes
question-deletedYesYesYesYes
tag-category-createdYesYesYesNo
tag-category-deletedYesYesYesNo
tag-category-mergedYesYesYesNo
tag-category-updatedYesYesYesNo
tag-createdYesYesYesNo
tag-deletedYesYesYesNo
tag-mergedYesYesYesNo
tag-updatedYesYesYesNo
team-member-addedYesNoNoNo
team-member-removedYesNoNoNo
usergroup-createdYesNoNoNo
usergroup-deletedYesNoNoNo
usergroup-member-addedYesNoNoNo
usergroup-member-deletedYesNoNoNo

Have any questions? Please email [email protected] for help.

Updated a day ago

Getting Started with Guru's Webhook Services


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.