Skip to main content

Guru Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Guru location.
guru_api.png

Guru

  1. Click the + icon on the Nexset that will be sent to the Guru destination, and select the Send to Destination option from the menu.

  2. Select the Guru connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Guru account, and click Next; or, create a new Guru credential for use in this flow.

  3. In Nexla, Guru destinations can be created using pre-built endpoint templates, which expedite destination setup for common Guru write endpoints. Each template is designed specifically for the corresponding Guru endpoint, making data destination setup easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Guru destinations can also be configured manually, allowing you to send data to Guru endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Guru endpoints. Each template is designed specifically for the corresponding Guru endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your destination for this endpoint.

    Ask a Question

    Submits a question to receive answers from the Guru knowledge base, with optional agent and context parameters. Use this endpoint to power automated Q&A workflows or to route questions from external systems into Guru's AI answer engine.

    • Sends a POST request to the Guru AI answers endpoint with a Question payload and optional parameters for Agent ID, Minimal Answer Only, Bypass Question Detection, Context, Chat Thread ID, and Thread Type.
    • Configure the following parameters: Question — the question text to submit. Agent ID — optionally target a specific AI agent. Minimal Answer Only — return only the answer text without sources.

    This endpoint is available only on Guru plans that include the AI Answers feature. Confirm plan eligibility before configuring this destination.

    Create Card (Extended)

    Creates a new Guru card (knowledge article) with content, title, share status, and verifier. Use this endpoint to programmatically publish knowledge from external systems such as CRMs, ticketing platforms, or documentation repositories.

    • Sends a POST request to the Guru cards endpoint. The request body must include at minimum a content field (HTML) and a preferredPhrase (card title).
    • Additional fields such as shareType, verifiers, tags, and collection can be included to fully configure the published card.

    Cards created via API are published immediately unless drafted first using the Create Draft Card endpoint. Ensure that the collection field references a valid collection ID accessible with your credential.

    Create Collection

    Creates a new Guru collection, which is the top-level content container for organizing cards and boards. Use this endpoint to programmatically provision knowledge collections for new teams, projects, or domains.

    • Sends a POST request to the Guru collections endpoint with the collection name and configuration in the request body.
    • A User Token with collection management permissions is required to create collections.

    Collection creation requires appropriate admin permissions. Verify that the credential used has sufficient privileges before configuring this destination.

    Create Draft Card

    Creates a draft card prior to publishing, allowing content to be staged for review before it becomes visible to team members. Use this endpoint when cards require editorial review or approval before going live.

    • Sends a POST request to the Guru draft cards endpoint with the card content and metadata in the request body.
    • Draft cards are not visible to regular users until published. They can be reviewed and published from the Guru interface or via the Verify Card endpoint.

    Draft cards can be promoted to published status using the Guru web interface or the card verification API. Drafts do not count against knowledge base search results until published.

    Invite Member

    Invites a new member to the Guru team by email. Use this endpoint to automate onboarding workflows that provision Guru access based on HR or directory system events.

    • Sends a POST request to the Guru members endpoint with the invitee's email address and optional role information in the request body.
    • The invited user will receive an email invitation to join the Guru team.

    Admin-level permissions are required to invite new members. Confirm that your Guru plan supports the number of members being provisioned.

    Update Card

    Updates an existing Guru card's content, title, tags, verifier, or share status. Use this endpoint to keep knowledge cards in sync with changes in external source systems.

    • Sends a PUT request to /api/v1/cards/{cardId} with the updated card fields in the request body.
    • Configure the following parameters: Cardid — the unique identifier of the card to update.

    The card author or a Collection Manager must own the card to update it. Use the Get Card by ID source endpoint to retrieve current card content before updating.

    Remove Member

    Removes a member from the Guru team. Use this endpoint to automate offboarding workflows that revoke Guru access when a user departs or changes roles.

    • Sends a DELETE request to /api/v1/members/{memberId}.
    • Configure the following parameters: Memberid — the unique identifier of the member to remove.

    Admin-level permissions are required to remove members. This action is irreversible — the removed member will lose access to all Guru collections immediately.

    Verify Card

    Marks a card as verified, resetting its verification timer. Use this endpoint to programmatically confirm that knowledge cards are up-to-date as part of a content governance workflow.

    • Sends a PUT request to the verify endpoint for a specific card.
    • Configure the following parameters: Cardid — the unique identifier of the card to verify.

    Only designated card verifiers or Collection Managers can verify a card via the API. Verifying a card resets its verification interval to the configured default.

    Delete Card

    Archives or deletes a Guru card by ID. Use this endpoint to programmatically remove outdated or incorrect knowledge cards from the Guru knowledge base.

    • Sends a DELETE request to /api/v1/cards/{cardId}.
    • Configure the following parameters: Cardid — the unique identifier of the card to delete.

    Deleting a card archives it rather than permanently removing it. Archived cards can be restored from the Guru interface. Admin or Collection Manager permissions are required.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a sample payload to the Guru API to ensure that the destination is set up correctly.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Guru destinations can be manually configured to send data to any valid Guru API endpoint. You can also configure Nexla to automatically send the response received from the Guru API after each call to a new Nexla webhook data source.

Common use cases for sending data to Guru include:

  • Creating or updating Cards programmatically from external data sources
  • Adding members to Guru groups or teams based on directory data
  • Archiving or updating knowledge card content from CRMs, ticketing systems, or other platforms

First, select the API method that will be used for calls to the Guru API from the Method pulldown menu. Common methods for Guru destinations include:

  • POST: For creating new Cards, Boards, or other Guru resources
  • PUT: For replacing an existing Guru resource in full
  • PATCH: For partially updating an existing Guru resource (e.g., updating specific fields of a Card)
  • DELETE: For removing Guru resources programmatically

Data Format​

  1. Select the format in which the Nexset data will be sent to the Guru API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Guru API expects data in JSON format for write operations.

API Endpoint URL​

  1. Enter the URL of the Guru API endpoint to which you want to send the Nexset data in the URL field. The Guru API root URL is https://api.getguru.com/api/v1/. For update operations, include the ID of the resource to be updated at the end of the URL.

    Example endpoint URLs for common Guru write operations:

    • Create a Card: https://api.getguru.com/api/v1/cards
    • Update a Card: https://api.getguru.com/api/v1/cards/{'{cardId}'}
    • Add a team member: https://api.getguru.com/api/v1/teams/{'{teamId}'}/members

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any authentication headers in the Request Headers field — the Basic Authentication credentials configured in your Guru credential are automatically included in every request.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Guru destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

The Guru API may enforce rate limits on write endpoints. Review the Guru API documentation for current rate limit information and adjust your batch size and flow schedule accordingly to avoid exceeding limits.

Response Webhook​

Optional

Nexla can automatically send the response received from the Guru API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Guru API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Guru API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Guru API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Guru endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Guru API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.