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

# Siro

> What Hatch's Siro integration is, how it works, and where to begin.

## What does the Siro integration do?

Hatch offers a native integration with Siro that you can activate within the App Marketplace (located in your Hatch workspace). This integration syncs Follow-up data from Siro to Hatch, and can also sync Hatch communications back to Siro.

While active, the Siro integration will sync new and updated Siro Follow-up data every 15 minutes. It can also update Follow-up status in Siro when communications are sent from Hatch campaigns.

To get started, open the App Marketplace in your Hatch workspace and follow the setup instructions below.

## How do you set up the integration?

### Requirements

You will need the following to set up the integration:

* Hatch account with manager privileges
* Siro account with admin access (the integration requires an admin user to create OAuth credentials)

### Setup Steps

<Steps>
  <Step title="Open App Marketplace">
    In Hatch, open the **App Marketplace**.
  </Step>

  <Step title="Connect Siro">
    Under the **CRMs** tab, click the Siro **Connect** button.
  </Step>

  <Step title="Start Setup">
    In the window that appears, click the **Start Setup** button.
  </Step>

  <Step title="Provide API Token">
    Follow the steps of the setup, clicking the **Next** button after each screen is completed. You will need to provide your Siro API Token during setup.
  </Step>

  <Step title="Finish Setup">
    In the final screen of the setup, click the **Finish** button.
  </Step>
</Steps>

<Note>
  When the integration is first enabled, Hatch will automatically create an OAuth App in your Siro account. This is used to securely authenticate API requests. Hatch will also sync the last 2 months of Follow-up data from Siro.
</Note>

## When does Hatch sync data to/from Siro?

### Siro → Hatch

Siro data can be synced to Hatch in the following scenarios. These options are configured during the integration setup.

<Note>
  Keep in mind that syncs occur every 15 minutes.
</Note>

* If a Follow-up record is created or updated in Siro, Hatch syncs the Follow-up record along with any associated customer data (see below for specific fields)

<Info>
  Only Follow-ups with a score higher than 3 are included by Siro. This means Hatch will only receive high-quality follow-up opportunities that Siro's AI has identified as having strong potential.
</Info>

### Hatch → Siro

Hatch communications can be synced to Siro in the following scenarios. These options are configured during the integration setup. If enabled, Hatch will update the Follow-up status to "COMPLETED" and add the communication details to the Follow-up notes.

<Note>
  Keep in mind that push communications occur instantaneously. There must be a Siro Follow-up record in Hatch at the time of the communication event in order for it to succeed.
</Note>

* When a Hatch campaign sends a text/email/voicemail to a contact
* When a contact calls or sends a text/email/voicemail to a Hatch workspace
* When a Hatch user calls or sends a text/email to a contact

## What Siro data is available in Hatch?

### Detail Field Lists

The following fields are available in the opportunity details:

**Follow-up Opportunity**

| Field                                  | Type   |
| -------------------------------------- | ------ |
| follow\_up                             | Object |
| follow\_up:repName                     | String |
| follow\_up:dateCreated                 | Date   |
| follow\_up:followupId                  | String |
| follow\_up:followupType                | String |
| follow\_up:score                       | Number |
| follow\_up:followupAction              | String |
| follow\_up:updatedAt                   | Date   |
| follow\_up:status                      | String |
| follow\_up:crmCustomer                 | Object |
| follow\_up:crmCustomer:id              | String |
| follow\_up:crmCustomer:name            | String |
| follow\_up:crmCustomer:emailAddress    | String |
| follow\_up:crmCustomer:phoneNumber     | String |
| follow\_up:context                     | Object |
| follow\_up:context:FollowupEmailHeader | String |
| follow\_up:context:FollowupTextHeader  | String |

<Tip>
  **Using Siro's AI-Generated Follow-up Messages**

  The `FollowupEmailHeader` and `FollowupTextHeader` fields contain AI-generated message content that Siro creates based on the sales call analysis. If you want to use Siro's suggested follow-up text in your Hatch campaigns, you can reference these fields using snippets like `[[Opportunity Details follow_up:context:FollowupTextHeader]]`.

  We recommend using `FollowupTextHeader` (the text message version) rather than `FollowupEmailHeader`, as the email version may contain formatting that is not fully supported in Hatch campaigns.
</Tip>

### Standard Field Mapping

Hatch standard fields are mapped from Siro detail fields as detailed below.

**Follow-up Opportunity**

<Note>
  The base object of this opportunity model is the Siro **Follow-up**. Therefore, (as an example) the **followupId** field would indicate the ID of the Siro **Follow-up** record.
</Note>

In Follow-up opportunities, the following Hatch standard fields are mapped from Siro detail fields:

| Hatch Standard Field                                       | Siro Detail Field                      |
| ---------------------------------------------------------- | -------------------------------------- |
| Email                                                      | crmCustomer:emailAddress               |
| External ID                                                | followupId                             |
| External Contact ID                                        | crmCustomer:id                         |
| External Created At                                        | dateCreated                            |
| External Updated At *(used for Hatch opportunity sorting)* | updatedAt                              |
| First Name                                                 | crmCustomer:name (first part of name)  |
| Last Name                                                  | crmCustomer:name (second part of name) |
| Phone Number                                               | crmCustomer:phoneNumber                |
| Status                                                     | status                                 |

## Configuration Options

The following options can be configured during integration setup:

* **Enabled Resources** — Choose which Siro data types to sync (Follow-ups)
* **Sync user communications with Siro Follow Up Notes** — Enable/disable pushing Hatch communications back to Siro

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="Will Hatch change Follow-up statuses in Siro?">
    Yes, if you have enabled the "Sync user communications with Siro Follow Up Notes" option. When the first campaign message is sent to a contact, Hatch will update the corresponding Follow-up status to "COMPLETED" and add the message content to the Follow-up notes.
  </Accordion>

  <Accordion title="How often does the integration sync?">
    Our integration syncs every 15 minutes.
  </Accordion>

  <Accordion title="What information is pushed back to Siro?">
    When communications are sent from Hatch campaigns, the integration can update the Follow-up status to "COMPLETED" and add the message content to the Follow-up notes field in Siro. This helps sales reps track that outreach has been completed.
  </Accordion>

  <Accordion title="What happens when the integration is disconnected?">
    When the integration is disabled, Hatch will stop syncing data to and from Siro.
  </Accordion>

  <Accordion title="What Siro user permissions are required?">
    The integration requires admin access to your Siro organization. During setup, the first admin user of your organization will be used to create the OAuth credentials needed for API access.
  </Accordion>

  <Accordion title="Which Follow-ups does Hatch receive from Siro?">
    Hatch receives Follow-ups that have a score higher than 3. Siro filters these on their end, so only high-quality follow-up opportunities are sent to Hatch. The score (ranging from 1-5) indicates how promising Siro's AI considers the follow-up opportunity to be.
  </Accordion>
</AccordionGroup>