Skip to main content

Setting Up Your Connector for Sending Messages to SyncHive

In this guide, we'll show you how to set up your Connector to be able to send messages to SyncHive. We'll use an example where we receive a product webhook event from Shopify, transform its contents into a message, and send it to SyncHive.

Requirements​

To follow this guide, you will need:

  1. Access to a Shopify store
  2. The ability to configure a Shopify store to send webhooks
  3. Power User access to the SyncHive Connect App

1. Adding your Connector to SyncHive​

Adding your Connector to SyncHive, is letting SyncHive know about your Connector.

To add a Connector: Log in to the SyncHive app and navigate to the Connectors page. Click the Add Connector button to begin. Follow the on-screen instructions to configure your Connector. We'll guide you through the setup steps below.

Connector information:​

In this step, we'll enter the essential details needed to create your Connector in SyncHive. We recommend selecting a name for your Connector that clearly indicates the platform it connects to.

Example Configuration:

  • Name: ShopifyConnector
  • Key: shopify_connector
  • Schema: limber
  • Status: Enabled
  • Version: 1.0.0
  • Group: ECommerce
  • External Contact Type: None

Connector Contact:​

We'll set these fields up as None for now. These fields are used by SyncHive to contact the connector, so we'll set these up later.

  • Contact Type: None
  • Contact Format: None
  • Auth Type: None

Connector Registration:​

Now, let's set up the Connector Registration. This step defines how your Connector will authenticate and communicate with SyncHive.

In this example, we'll be using an API Key to authenticate our Connector calls to SyncHive.

Example Configuration:

  • Registration Type: API Key
  • API Key Header: X-Shopify-Connector-Key
  • API Key Value: 9XnZr4JmPWTVHuyFBheg

Connector Shapes:​

We'll be exchanging product-related information between SyncHive and Shopify. To enable this, edit the Product Shape on the screen and configure it as follows:

  • Inbound Status: Enabled
  • Check Request Type: Last Check Time
  • Allow Update Polling: No
  • Allow Update Notification: Yes

This signals to SyncHive that the Connector supports inbound (Connector to SyncHive) messages.

Connector Properties:​

For now, let's skip this step to keep things simple.

Connector complete:​

Awesome! You've set up your Connector in SyncHive. Let's exit the Connector creation process and move on to configuring an Integration.

2. Adding an Integration to SyncHive​

Navigate to the Integrations page and click the Add Integration button to begin. Follow the on-screen instructions to configure your Integration. We'll guide you through the setup steps below.

Integration information:​

Just like when we set up your Connector, we'll now enter the key details needed to create your Integration in SyncHive.

Example Configuration:

  • Name: ShopifyNzIntegration
  • Key: shopify_nz_integration
  • Connector Key: shopify_connector
  • Status: Enabled
  • Version: 1.0.0
  • Group: ECommerce
  • Tenant ID: myshopifystore

The Tenant ID can be used to identify an Integration from the Connector. In a webhook context, a Connector may need to use a value provided by the webhook to identify which Integration the event is for.

E.g. a Shopify webhook provides a header x-shopify-shop-domain, with the domain name the store is hosted. This can be used to identify which Integration the webhook is for, by registering the value as a Tenant ID.

Integration Contact:​

We can skip this step for this example. These fields are intended for use by the Connector to connect to a system and are not necessary for this guide.

Integration Shapes:​

It's time to configure the Product Shape for this Integration. Edit the Product Shape and set it as follows:

  • Mode: Live
  • Inbound Status: Enabled
  • Inbound Update Type: Event
  • Check Frequency: Never
  • Inbound Filter Status: Disabled

Integration Properties:​

For now, let's skip this step to keep things simple.

Integration complete:​

Congratulations! You've set up your Connector and Integration in SyncHive. You're all set to begin using your Connector to communicate with SyncHive.

Next steps: Implementation​

This guide covered the setup of our Connector and Integration in SyncHive. In the next guide, we'll cover the implementation.