Voyado Engage

API connections

The Engage configuration area allows you to set up API keys in a flexible way. API keys can be easily created without linking them to specific users, as well as refreshed or deleted when needed.

This is all done in the API Connections section of Config Hub.

Voyado strongly recommends that you always have an individual unique API key for every integration / system you will use to communicate with Engage. This simplifies troubleshooting and reduces the problems and time needed when an API key is changed or needs to be shut down / terminated.

The API Connections page

Select API Connections from the menu. This takes you to a list of the currently active API connections for your tenant, and shows you what type they are and what they are intended to be used for.

Screenshot of API keys overview in Engage Config

Adding a connection

Selecting Add connection will bring up this panel.

Add API connection dialog in Engage Config

Name: Either select an existing name from the dropdown, or choose the Other option if you want to add a new name (in which case the Other name field will appear). Since these API keys are usually connected to a specific integration, it's helpful to include the integration's name.

There is no validation of names, and several connections can share the same one.

Other name: If you've chosen Other as name, this field appears. Enter the name you want here.

Type: Select an existing type from the dropdown, or choose the Other option to add a new one. This causes the Other type field to appear.

Other type: If you've chosen Other in the previous dropdown, enter your value for type here.

API allowlist: Here you can enter, as a comma-separated list, all the IP addresses that are allowed to make calls using this API key. If this field is left empty, all IP addresses are allowed.

Editing a connection

Clicking the "meatball menu" to the right of each entry brings up this menu:

Screenshot of menu for API connections in API keys overview panel

From here you can edit the entry, re-generate its API key, or delete it.

Choosing Edit connection brings up this panel:

Edit API connection dialog in Engage Config

Here you can change any of the values you entered when you created the connection.

Article last reviewed

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.