Third-Party Catalog Integrations: Zapier

Before setting up a Zap, the user must obtain his personal API key:

1. Log in to Admin Console.
2. Go to Accounts.
3. Choose the desired Account.
4. Go to “Zaps” tab.
5. Click Generate API Key.
6. Copy the API Key to your clipboard.

1. Go to your Zapier account: https://zapier.com/
2. Click “Create Zap“.
3. In the Trigger step, choose the app that will send data (e.g., Google Sheets, Webhooks, Airtable).
4. Set up and test the trigger.
5. Click “+” to add an Action.
6. Search for NoviSign Digital Signage app.
7. Select the “Publish Message” action.
8. When prompted to connect your account:
   • Click “Connect a new account“
   • Paste the API Key you copied earlier
   • Click Continue
9. Zapier will test the key. If valid, it will connect and return you to the action setup.

Zapier will show a form with the fields your action supports. Here’s how to fill them out:

Required Fields

Channel Name

• Purpose: Group messages logically
• Example: “product-launch”, “inventory-feed”
• Tip: You can use a static value or map it from the trigger data

Message ID

• Dynamic: Use a field from the trigger to create unique entries (e.g., “Response ID”, “UUID”)
• Static: Use a constant value (e.g., “current-offer”) to overwrite the same message every time

Max Messages in Channel

• Define FIFO limit (e.g., 5 means only the last 5 messages are kept)

Data

• Purpose: This is the full content of the message
• Tip: You can use multiple data for inputs
• Tip: Use Zapier’s “Custom” option to map each part from the trigger

Optional Fields (Used for Filtering Later)

Start Date

• Optional: Map if the message represents an event (e.g., promotion start)

End Date

• Optional: Event expiration or offer end
• Tip: Can be used for time-range queries later
• Tip: Use the 2 above fields for smooth integration with event managing apps like Google Calendar, Outlook etc.

Quantity

• Optional: For inventory, stock levels, etc.
• Example: 10, 100, etc.
• Tip: Use this field to manage “in-stock” items

Click “Test Step” to send the message

Once the test succeeds:

1. Click “Publish”
2. Name your Zap (e.g., “Push New Typeform Submissions to NoviSign”)
3. Turn it ON

To retrieve regular items, use the following endpoint format:

https://{studio-domain}/catalog/{account}/itemsgroup/{itemsgroup}

Path Parameters

• {studio-domain} – Your dedicated Studio domain.

• {account} – The ID of the account associated with your integration. You can find this ID in the Studio Settings or via the Admin Console.

• {itemsgroup} – The required grouping key used for organizing data per integration (e.g., the “Channel name” in Zapier or “Import name” in Imports).

Link Example:

https://test.novisign.com/catalog/d2e2c2e4-c885-497d-9324-2f17f51fd36a/itemsgroup/inventory

• Turn on Load Preview Parameters

• Click on API Integration -> Add

• Put link to API URL field

• Specify Integration Name and Property key

• Press Test to fetch and see retrieved data

• If everything is OK, click Save

• Add Text or Label widget to canvas

• Type ${ to see Compose JSON dialog

• Hit Insert a dynamic value and choose @customapi to use API Integration data

• Hit Insert a dynamic value again and choose previously created API Integration

• Now you can use the received dynamic properties

• Open player settings -> External Interfaces -> Custom API Integration -> Add

• Use the same values as in Step 7:

• Type link to API URL field

• Specify Integration Name and the same Property key you used in the creative

• Specify Refresh interval (sec)

• Click Save

• In Studio, go to Advanced Settings -> Configurations

• Create or edit existing configuration

• Navigate to External Interfaces -> API Integration

• Use the same values as in Step 7

• Return to Studio and apply configuration to Screen