You can use your Celigo APIs connection to create an export, import, or lookup. Using these resources, you can invoke JavaScript APIs, custom APIs built with API builder, or integrator.io REST APIs.
Note
This article only covers the Simple view. There may be additional customization options in the HTTP view. Learn more about simple vs. HTTP views.
After creating your resource, you must configure the following:
Options * (required): You can choose...
-
Invoke an API created in my account
-
Send data to a listener in another flow
-
Invoke Celigo standard resource APIs
Note
This option is only available for Celigo APIs connections with Full access.
API endpoint *: Select the API endpoint you'd like to invoke. These endpoints are based on the Celigo APIs connection you chose and the API(s) you added to the connection's scopes. It includes both custom APIs and JavaScript APIs.
HTTP method * (JavaScript APIs): For custom APIs built in API builder, the HTTP method is automatically inherited from the API endpoint you selected and can't be edited. For JavaScript APIs, you must select the HTTP method.
Additional fields (Path parameters) * (API builder APIs): Any of your custom API's path parameters are dynamically retrieved and listed as additional fields. For example, if your API retrieves a pet, it may require a specific pet ID or store ID.
Query parameters: You can add any additional query parameters here. For example, if your API retrieves a pet, you may be able to specify the petType using query parameters. The query parameters will appear in a drop-down when you're invoking a custom API. You must manually add query parameters if you're invoking a JavaScript API.
HTTP headers (not required): Any HTTP headers you've included in your custom or JavaScript API can be used here.
Export a JavaScript API endpoint (Simple view)
Export an API builder API endpoint (Simple view)
Listener *: Select the listener you'd like to send data to. This list is taken from the list of listeners you selected when you created a connection to Celigo APIs.
Note
This option is only available for Celigo API connections with Full access.
Resource *: Select the API resource you'd like to use. See the list of APIs available through the Celigo platform and the list of all available REST APIs..
API endpoint *: Select the API endpoint you'd like to invoke.