Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Postscript source in Nexla.
postscript_api.png

Postscript

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Postscript connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Postscript account, and click Next; or, create a new Postscript credential for use in this flow.

  3. In Nexla, Postscript data sources can be created using pre-built endpoint templates, which expedite source setup for common Postscript endpoints. Each template is designed specifically for the corresponding Postscript endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Postscript sources can also be configured manually, allowing you to ingest data from Postscript endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Postscript endpoints. Each template is designed specifically for the corresponding Postscript endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get message request by id

    This endpoint template retrieves a message request by its ID from your Postscript account. Use this template when you need to retrieve information about a specific message request, including message status, content, and other message metadata.

    • Enter the message request ID in the Message request Id field. This should be the unique identifier of the message request you want to retrieve. The message request ID determines which message request's information will be retrieved.

    This endpoint returns a message request by its ID from your Postscript account, including message status, content, and other message metadata. The endpoint returns a single message request's information.

    For detailed information about message requests, API response structures, and available message data, see the Postscript API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Postscript data sources can be manually configured to ingest data from any valid Postscript API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Postscript sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Postscript API from the Method pulldown menu. Postscript API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Postscript API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Postscript endpoint (e.g., https://api.postscript.io/api/v2/message_requests/{id}). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Postscript API endpoint URL should include the API version (/api/v2/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Postscript API responses, use $ to extract the entire response for single record endpoints, or $.items[*] to extract all items from the items array for list endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Postscript API response. Postscript API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.