Data Retrieval Actions

These Nodes are used to connect to external APIs or services.

• GraphQL: Connects to a GraphQL API to build and execute requests.
• Network Request: Builds HTTP requests to arbitrary non-GraphQL endpoints.

GraphQL

This Node makes it easy to connect to a GraphQL API. After providing an endpoint, you can visualize the available queries, mutations, and fields using a GUI-based editor.

To provide an endpoint and customize your request, select the GraphQL Node on the Canvas and then open the Settings cog in the Right Sidebar.

• Endpoint and Headers: Provide the URL for the API in the endpoint field. You can add custom headers by clicking the + icon in the Headers section and specifying the key and value.

• Exploring the API: Once an endpoint is provided, Shipcode automatically retrieves the API’s schema. Right-click on the GraphQL Document field and select Edit GraphQL Query to view Queries (data structure) and Mutations (actions).
• Selecting Data: In the Query tab, you can select individual pieces of data. Items that can be selected have a radio button next to them. Clicking the button automatically updates the GraphQL Document field.
• Filtering Data with Variables: You can filter retrieved data with variables. Supported variables automatically appear in the GraphQL Variables section. You can provide information for any of the variables or leave them blank for unfiltered results.
• Working with Mutations: A Mutation refers to an action you can perform against an API that changes, or mutates, the server data. To create one, open the Query Editor and select the Mutations tab. The required Variables will appear in the GraphQL Variables section when you select a specific Mutation. You can include multiple Mutations in a single request.

Network Request

The Network Request Node is used for non-GraphQL requests to build HTTP requests to arbitrary endpoints. You can specify the endpoint, headers, and data using either static values or dynamic data from other inputs or Nodes.

To configure a Network Request, select the Node and then click on the Settings cog in the Right Sidebar.

• URL: The endpoint to the API for which the request will be made.
• Method: Use the dropdown to select the appropriate HTTP verb (e.g., GET or POST).
• Data: For request types that support a request body (POST, PUT), you can specify the data here, either hardcoding it or selecting data from another Node.
• Params: Define query parameters (keys and values after the “?” in a URL). Click the + icon to add a new parameter.
• Headers: Set any number of custom headers in the request. Click the + icon to add a new header.
• Timeout: Optionally provide a timeout, in milliseconds, at which point the request will fail.
• With Credentials: Enabling this toggle instructs the browser to include cookies or authentication headers when making a request to a different website, which is not the default behavior.