> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho Sprints Webhook Setup Guide

> Configure Zoho Sprints to deliver events to StackOne.

## Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See [Getting Started](/connectors/zohosprints#getting-started) on the Zoho Sprints connector page.

<section data-guide-section data-guide-scopes="">
  <h2>Automatic webhook setup</h2>

  <p>StackOne creates and manages the Zoho Sprints webhooks automatically when the account is connected, and removes them when the account is disconnected. One webhook, named StackOne followed by the event code, is created for each event you enable, so there is nothing to configure in Zoho Sprints.</p>

  <ul>
    <li>The connection needs the default OAuth scopes, or custom scopes that include `ZohoSprints.webhook.READ`, `ZohoSprints.webhook.CREATE` and `ZohoSprints.webhook.DELETE`.</li>
    <li>Do not edit or delete the StackOne webhooks under <strong>Settings</strong> > <strong>Automation</strong> > <strong>Webhooks</strong> in Zoho Sprints. Doing so stops event delivery for that event.</li>
  </ul>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Available webhook events</h2>

  <p>The following Zoho Sprints events can be enabled. Only events selected in StackOne get a webhook, so Zoho Sprints will not deliver events that are not subscribed.</p>

  <Steps>
    <Step title="Project events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to projects in the workspace.</p>

        <ul>
          <li><strong>Project Created</strong> (`project_create`) — Fired when a project is created</li>
          <li><strong>Project Updated</strong> (`project_update`) — Fired when a project is updated</li>
          <li><strong>Project Deleted</strong> (`project_delete`) — Fired when a project is deleted</li>
          <li><strong>Project Archived</strong> (`project_archived`) — Fired when a project is archived</li>
        </ul>
      </div>
    </Step>

    <Step title="User events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to users joining or leaving the workspace or a project.</p>

        <ul>
          <li><strong>Project User Added</strong> (`user_project_create`) — Fired when a user is added to a project</li>
          <li><strong>Project User Removed</strong> (`user_project_delete`) — Fired when a user is removed from a project</li>
          <li><strong>Workspace User Added</strong> (`user_team_create`) — Fired when a user is added to the workspace</li>
          <li><strong>Workspace User Removed</strong> (`user_team_delete`) — Fired when a user is removed from the workspace</li>
        </ul>
      </div>
    </Step>

    <Step title="Sprint events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to sprints and their lifecycle.</p>

        <ul>
          <li><strong>Sprint Created</strong> (`sprint_create`) — Fired when a sprint is created</li>
          <li><strong>Sprint Updated</strong> (`sprint_update`) — Fired when a sprint is updated</li>
          <li><strong>Sprint Deleted</strong> (`sprint_delete`) — Fired when a sprint is deleted</li>
          <li><strong>Sprint Started</strong> (`sprint_start`) — Fired when a sprint is started</li>
          <li><strong>Sprint Completed</strong> (`sprint_complete`) — Fired when a sprint is completed</li>
        </ul>
      </div>
    </Step>

    <Step title="Sprint comment events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to comments on sprints.</p>

        <ul>
          <li><strong>Sprint Comment Created</strong> (`sprint_notes_create`) — Fired when a comment is added to a sprint</li>
          <li><strong>Sprint Comment Updated</strong> (`sprint_notes_update`) — Fired when a sprint comment is edited</li>
          <li><strong>Sprint Comment Deleted</strong> (`sprint_notes_delete`) — Fired when a sprint comment is deleted</li>
        </ul>
      </div>
    </Step>

    <Step title="Work item events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to work items (stories, tasks, bugs) in sprints and the backlog.</p>

        <ul>
          <li><strong>Item Created</strong> (`item_create`) — Fired when a work item is created</li>
          <li><strong>Item Updated</strong> (`item_update`) — Fired when a work item is updated</li>
          <li><strong>Item Deleted</strong> (`item_delete`) — Fired when a work item is deleted</li>
          <li><strong>Item Completed</strong> (`item_complete`) — Fired when a work item is closed (moved to a completed status)</li>
          <li><strong>Item Reopened</strong> (`item_reopen`) — Fired when a closed work item is reopened</li>
        </ul>
      </div>
    </Step>

    <Step title="Work item comment events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to comments on work items.</p>

        <ul>
          <li><strong>Item Comment Created</strong> (`item_notes_create`) — Fired when a comment is added to a work item</li>
          <li><strong>Item Comment Updated</strong> (`item_notes_update`) — Fired when a work item comment is edited</li>
          <li><strong>Item Comment Deleted</strong> (`item_notes_delete`) — Fired when a work item comment is deleted</li>
        </ul>
      </div>
    </Step>

    <Step title="Time log events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to logged hours.</p>

        <ul>
          <li><strong>Log Hours Created</strong> (`loghour_create`) — Fired when a time log is added</li>
          <li><strong>Log Hours Updated</strong> (`loghour_update`) — Fired when a time log is updated</li>
          <li><strong>Log Hours Deleted</strong> (`loghour_delete`) — Fired when a time log is deleted</li>
        </ul>
      </div>
    </Step>

    <Step title="Code integration events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events from a connected GitHub, GitLab or Bitbucket repository. They only fire when a repository integration is set up in Zoho Sprints.</p>

        <ul>
          <li><strong>Item Commit Created</strong> (`item_commit_create`) — Fired when a commit that references a work item is pushed to a connected repository (GitHub, GitLab or Bitbucket integration)</li>
          <li><strong>Item Pull Request Created</strong> (`item_pullreq_create`) — Fired when a pull request that references a work item is opened in a connected repository</li>
          <li><strong>Item Pull Request Updated</strong> (`item_pullreq_update`) — Fired when a pull request that references a work item is updated in a connected repository</li>
        </ul>
      </div>
    </Step>

    <Step title="Meeting events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to sprint meetings.</p>

        <ul>
          <li><strong>Meeting Created</strong> (`meeting_create`) — Fired when a meeting is created</li>
          <li><strong>Meeting Updated</strong> (`meeting_update`) — Fired when a meeting is updated</li>
          <li><strong>Meeting Deleted</strong> (`meeting_delete`) — Fired when a meeting is deleted</li>
          <li><strong>Meeting Started</strong> (`meeting_start`) — Fired when a meeting is started</li>
        </ul>
      </div>
    </Step>

    <Step title="Meeting comment events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to comments on meetings.</p>

        <ul>
          <li><strong>Meeting Comment Created</strong> (`meeting_notes_create`) — Fired when a comment is added to a meeting</li>
          <li><strong>Meeting Comment Updated</strong> (`meeting_notes_update`) — Fired when a meeting comment is edited</li>
          <li><strong>Meeting Comment Deleted</strong> (`meeting_notes_delete`) — Fired when a meeting comment is deleted</li>
        </ul>
      </div>
    </Step>

    <Step title="Epic events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to epics.</p>

        <ul>
          <li><strong>Epic Created</strong> (`epic_create`) — Fired when an epic is created</li>
          <li><strong>Epic Updated</strong> (`epic_update`) — Fired when an epic is updated</li>
          <li><strong>Epic Deleted</strong> (`epic_delete`) — Fired when an epic is deleted</li>
        </ul>
      </div>
    </Step>

    <Step title="Release events">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Events related to releases.</p>

        <ul>
          <li><strong>Release Created</strong> (`release_create`) — Fired when a release is created</li>
          <li><strong>Release Updated</strong> (`release_update`) — Fired when a release is updated</li>
          <li><strong>Release Deleted</strong> (`release_delete`) — Fired when a release is deleted</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Delivery format</h2>

  <p>Details of how Zoho Sprints delivers events to StackOne.</p>

  <Steps>
    <Step title="One event per request">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Each request carries a single event as a flat JSON body. It includes the record's fields (for example <strong>itemId</strong>, <strong>projectId</strong> and <strong>sprintId</strong> on work item events) and Zoho Sprints metadata such as <strong>zoid</strong> (the workspace ID) and <strong>actionby</strong> (the user who made the change). Update events also include <strong>fieldsUpdated</strong>.</p>
      </div>
    </Step>

    <Step title="Failed deliveries">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Zoho Sprints suspends a webhook after 5 consecutive failed deliveries. Reconnect the account in StackOne to recreate it.</p>
      </div>
    </Step>
  </Steps>
</section>

## Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.