For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LoginTalk to us
DocumentationSDKsConnectAPI Reference
DocumentationSDKsConnectAPI Reference
    • Home
    • Release Notes
  • Getting Started
    • Quickstart
    • Dashboard
    • Alarms
    • Versioning
  • Core Features
    • Integrations
    • Templates
    • Routes
    • Notification Events
    • Requests/Go Live
    • Logs
  • Advanced Features
    • Workflows
    • Campaigns
    • User Profiles
    • Approval Request
  • Settings
    • Profile Settings
    • Workspaces
    • Workspace Settings
      • Team
      • API Keys
      • Allowlist
        • HTTP
        • SQS
          • Configuring Endpoint - SQS
        • Receive Delivery Report
      • Alerts
      • Security
      • Delivery Limit
      • Block Email Domains
LogoLogo
LoginTalk to us
On this page
  • Enable Endpoint Configuration
  • Body Payload
  • Content Type
  • Payload Format
  • Payload Fields
  • Autofill
  • Encryption
  • Key Level Encryption
  • Purpose
  • Payload and Body Encryption Configurations
  • Request Type
  • Text Request Type
  • JSON Request Type
SettingsWorkspace SettingsAllowlistSQS

Configuring Endpoint - SQS

Was this page helpful?
Previous

Configuring Allowlist URL/SQS to receive Delivery Report

Next
Built with

The Configure Endpoint section allows you to configure how delivery reports are sent to the specified endpoint. This includes payload formatting, request configuration, and encryption settings for securing request data during transmission.

The available options and configurations may vary depending on the selected endpoint type and integration requirements.

Enable Endpoint Configuration

Enable the Use this endpoint to receive delivery reports toggle to activate endpoint configuration.

Once enabled, you can configure:

  • Endpoint URL
  • Body Payload
  • Encryption settings

Body Payload

The Body Payload section defines the structure and format of the request body sent to the configured endpoint.

Content Type

The Content Type field specifies the format of the outgoing request payload. Supported content types may vary depending on the endpoint configuration and payload format.

Payload Format

The payload can be configured using one of the following formats:

FormatDescription
FORMSends payload data as key-value pairs.
JSONSends payload data as a structured JSON object.

Payload Fields

Payload fields allow request parameters to be added as key-value pairs.

FieldDescription
KeyDefines the parameter name.
ValueDefines the parameter value.

Use Add Key to include additional payload parameters.

Autofill

The Autofill option automatically maps available delivery report fields into the payload configuration. This helps simplify payload setup and reduces manual mapping effort.

Encryption

The Encryption section provides options to secure request data before transmission. The following encryption modes are available:

Encryption TypeDescription
Key Level EncryptionEncrypts selected keys from the payload or headers.
Body EncryptionEncrypts the complete request body.

Key Level Encryption

The Key Level Encryption option encrypts only selected payload or header fields instead of encrypting the entire request body. Enable the toggle to activate key-level encryption.

Purpose

Key-level encryption is useful when:

  • Only specific fields contain sensitive information
  • Certain payload fields must remain readable in plaintext
  • Partial encryption is required by the receiving system

Payload and Body Encryption Configurations

Field / OptionDescription
Encryption MethodDefines the algorithm used for encrypting selected keys. Available methods may vary depending on the configured encryption settings.
EncodingDetermines how encrypted data is converted into a transferable format. Supported encoding formats may vary depending on the selected encryption method.
Encryption KeyUsed to encrypt and decrypt request data. The exact same key configuration must be available at the receiver end to successfully decrypt the payload. Key requirements may vary depending on the selected encryption method.
Initialization Vector (IV)Adds randomness to the encryption process and improves cryptographic security. IV requirements and supported formats depend on the selected encryption method.
Salt KeyAn additional random value used during encryption to improve security and reduce predictable encryption patterns.
Select KeysAllows you to choose which payload or header fields should be encrypted. Only selected fields are encrypted when key-level encryption is enabled.
Add Another MethodAllows multiple encryption methods to be configured simultaneously. This is useful when different payload fields require different encryption configurations.
Body EncryptionEncrypts the complete request body before transmission. Enable the toggle to secure the entire payload instead of encrypting specific fields only.
Body Encryption MethodDefines the algorithm used for full payload encryption. Available methods may vary depending on the endpoint configuration.
IV StrategyDetermines how the Initialization Vector is generated during encryption. Available strategies may include predefined or dynamically generated IV configurations depending on the selected encryption method.

Request Type

The Request Type option defines how the encrypted payload is transmitted in the outgoing request.

Request TypeDescription
TextSends the encrypted payload as encoded text.
JSONSends the encrypted payload within a structured JSON object.

Text Request Type

When the Text request type is selected:

  • The request body contains only the encrypted payload.
  • The payload is transmitted as encoded text.
  • No additional request structure is included.

This option is useful for integrations expecting raw encrypted content.

JSON Request Type

When the JSON request type is selected:

  • The encrypted payload is wrapped inside a JSON structure.
  • The request body follows a structured format.
  • Additional metadata can be included if required.

NOTE: This option is commonly used for APIs and webhook integrations expecting JSON payloads.