Skip to main content
Version: 2

GET Example

info

Available: Base

Overview​

This tutorial shows how to create an Inbound API in Plinqx Publisher that exposes an HTTP GET endpoint and routes the request into a Salesforce Flow for processing.

Prerequisites​

  • Plinqx package is installed and accessible in your Salesforce org.
  • You have permissions to access Plinqx Publisher and to create/deploy Flows.

1. Navigate to Plinqx Publisher (Inbound)​

  1. Open the Plinqx application.
  2. Go to the Plinqx Publisher tab.
  3. Filter to Inbound.

Plinqx Publisher inbound

2. Create a new API​

  1. Click New.
  2. In the wizard, enter:
    • Name (for example, GET Example)
    • Category (used for filtering)
    • Description (what the API does)

Create API

3. Configure API settings​

  1. Click Next.
  2. For Event Type, select API Service.

API settings

  1. Click Next.
  2. Enter an API Endpoint/URL (This is where the API will be reachable by external systems).
    • You can add wildcards.
    • Wildcards use curly brackets with a numeric value, for example {0}, {1}, and so on. You can add multiple wildcards if needed.

Email settings

4. Set direction and logic​

  1. Set Direction to Inbound.
  2. Choose Flow as the inbound logic.
  3. If you already have a Flow, select it from the dropdown. Otherwise, create a new Flow.

Direction and logic

5. Create a new Flow (template)​

  1. Check the New Flow checkbox.
  2. Provide a Flow Name.
  3. Click Next to generate and deploy the Flow template.

New Flow template

6. Configure HTTP method (GET)​

  1. Select the GET HTTP method.
  2. Select Activate when done to activate your API once deployed (you can activate after as well).
  3. Click Next.

HTTP method

7. Review and submit​

  1. Review your configuration.
  2. Click Submit.
  3. Wait for deployment to complete.

Review and submit

8. Access API details​

  1. Click Finish.
  2. Your new API appears in the list.
  3. Click the API record to view its details.

API details

9. Configure the Flow behind the API (GET flow)​

From the API details panel

  1. Click the Open in New Tab icon to access the Flow configuration.

Flow New Tab

  1. Work within the pre-configured HTTP methods (focus on GET for this example).

Flow configuration

10. Retrieve Salesforce records (example: Accounts)​

  1. Configure the Flow to retrieve Salesforce records (for example, Accounts).

Flow Get Accounts

  1. Filter to retrieve Accounts where Name is not null.

Get records

11. Convert records to JSON​

  1. Use the Convert S Object to JSON component to format records for REST APIs.

  2. Set Suppress Nulls to true to remove empty values from results.

Flow Convert to JSON

12. Set the response​

  1. Assign the output of the Convert to JSON object to the HTTP response.

Flow JSON Response

13. Test the API endpoint (GET)​

  1. Copy the API endpoint.

Workbench test

  1. Use Salesforce Workbench to execute a GET request.

  2. Inspect the returned responses.

Workbench response

14. Review Transactions​

  1. Open the Transactions tab to view called methods and blocked methods.

  2. Inspect the last successful GET request and its headers.

Transactions List

You can open and inspect the records as needed

Outcome​

You have created an Inbound API in Plinqx Publisher, deployed a supporting GET Flow, tested the endpoint via Workbench, and verified execution through Transactions.