Skip to main content

Setting Up Your Connector for Receiving Messages from SyncHive

In this guide, we will build on top of the prior example and set up your Connector to receive messages from SyncHive. We'll use an example where we receive a Product message from SyncHive and save it to Shopify.

Requirements​

  1. The API URL for your Shopify store
  2. The API credentials for your Shopify store
  3. Power User access to the SyncHive Connect App
  4. The ability for your Connector to be accessible via the public web. 1
  5. The Connector and Integration setup in our guide to sending messages to SyncHive

1. Configuring our Connector​

Log in to the SyncHive app and navigate to the Connectors page. Open up the Shopify Connector and we'll guide you through the next steps.

Connector Contact:​

First, we'll set up the Connector Contact information. This configures how SyncHive will authenticate and communicate with your Connector.

Example Configuration:

  • Contact Type: HTTP Endpoint
  • HTTP URL: https://www.my_connector_url.com
  • HTTP API Key: Yes
  • HTTP API Key Header: X-Shopify-Connector-Key
  • HTTP API Key Value: 9XnZr4JmPWTVHuyFBheg
  • Contact Format: JSON Document
  • Auth Type: None

The HTTP URL must be a publicly accessible URL for SyncHive to be able to reach. In this example we've setup an API key to authenticate SyncHive to the Connector. SyncHive will provide an HTTP header X-Shopify-Connector-Key with value 9XnZr4JmPWTVHuyFBheg. Other authentication methods are available.

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

Connector complete:​

Awesome! You've set up your Connector in SyncHive. Let's move on to configuring our Integration.

2. Configuring our Integration​

Navigate to the Integrations page and open up the Shopify Integration.

Integration Contact:​

Next, we'll configure the Integration Contact information. This info will be requested by your Connector when SyncHive calls your Connector API, helping to identify the destination system and how to authenticate with it.

Example Configuration:

  • Contact Type: HTTP Endpoint
  • HTTP URL: https://www.my_shopify_url.com
  • HTTP API Key: Yes
  • HTTP API Key Header: X-Shopify-Access-Token
  • HTTP API Key Value: 3tuCsUi3zopbxWmuqFDe
  • Contact Format: JSON Document
  • Auth Type: None

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
  • Outbound Status: Enabled
  • Outbound Filter Status: Disabled

Integration complete:​

Congratulations! You're all set to begin using your Connector to receive messages from 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.

Footnotes​

  1. ngrok can be a useful technology to help develop a Connector locally ↩