Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Postscript location.
postscript_api.png

Postscript

Create a Postscript Destination​

  1. Click the + icon on the Nexset that will be sent to the Postscript destination, and select the Send to Destination option from the menu.

  2. Select the Postscript connector from the list of available destination 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 destinations can be created using pre-built endpoint templates, which expedite destination setup for common Postscript endpoints. Each template is designed specifically for the corresponding Postscript endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

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

Configure Using a Template​

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

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    post_message_request

    This endpoint template sends message requests to your Postscript account using records from a Nexset. Use this template when you need to send SMS messages to customers through Postscript. Messages that are sent via the API still have to obey text messaging rules and regulations, which means Postscript has guardrails in place for all messages sent through the API.

    • This endpoint automatically sends message requests from your data. No additional configuration is required beyond selecting this endpoint template. The request body should contain the message request data in JSON format matching the Postscript API structure.

    This endpoint sends data as JSON in the request body to create message requests in your Postscript account. Each record from your Nexset will be sent as a separate API request to send a message in Postscript. The request body should contain the message request data in the format required by the Postscript API.

    Messages sent via the API must comply with text messaging rules and regulations. Postscript has guardrails in place for all messages sent through the API to ensure compliance. The message structure must match the Postscript API's expected format. For detailed information about message creation, request body formats, available message properties, and messaging compliance, see the Postscript API documentation.

Configure Manually​

Postscript destinations can be manually configured to send data to 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.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Postscript API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, 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 POST method for creating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Postscript API from the Content Format pulldown menu. Postscript API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Postscript API endpoint to which data will be sent in the URL field. This should be the complete URL to your Postscript endpoint (e.g., https://api.postscript.io/api/v2/message_requests). 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 point to the endpoint where you want to create message requests. The 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.

Request Body​

  1. Configure the request body that will be sent to the Postscript API. The request body should contain the message request data formatted as JSON, with field names matching the Postscript API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Postscript API's expected format for message requests. Messages sent via the API must comply with text messaging rules and regulations. Postscript has guardrails in place for all messages sent through the API. For detailed information about request body formats, available endpoints, and message structures, see the Postscript API documentation.

Save the Destination​

  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 destination configuration for later use.