HTTP API Destination

The HTTP API Destination allows you to send data to any custom endpoint with complete control over the request format. This destination is ideal for integrations with platforms that are not directly supported by Ours. You can configure headers, HTTP methods, and request bodies while maintaining HIPAA compliance.

Features of the HTTP API Destination

• Custom URL: Specify the endpoint URL to which data should be sent.
• Customizable HTTP Method: Choose between POST and GET requests.
• Advanced Data Mapping: Map internal data to the desired structure for your endpoint, including custom transformations.
• Headers Configuration: Add custom headers for authentication or other requirements.
• HIPAA Compliance: Ensure all data sent is compliant with privacy regulations, including hashing or redacting sensitive information.

Configuring the HTTP API Destination

1. Add the Destination

1. Log in to your Ours account and navigate to the Destinations section.
2. Click Add Destination and select HTTP API Destination.
3. Provide a Name for the destination to distinguish it from others.
4. Enter the Destination URL (e.g., https://api.example.com/data).

2. Define the Mapping

After creating the destination, configure the data mapping to control how your data is structured when sent to the endpoint.

Default Mapping

1. Navigate to the Mappings tab of the HTTP API Destination.
2. Click on Default Mapping to configure the default mapping for the destination.
3. Use the interface to map internal data (e.g., value, currency) to the desired structure:
   • JSON Body/Data: Map each field to a value (e.g., currency → USD).
   • Headers: Add custom headers such as Authorization or Content-Type.
   • Query Parameters: Map any query parameters required by the endpoint.

3. Configure the HTTP Method

You can choose between POST and GET for your requests:

• Use POST for sending data in the body.
• Use GET for sending data in query parameters.

Set the HTTP method in the Default Mapping section or override it for specific events in the custom mapping.

Example Use Case

Sending Data to a Custom CRM Endpoint

Imagine you want to send event data to your CRM that requires:

• A specific API key in the header.
• Data in the following format:

{
  "value": 1,
  "currency": "USD",
  "blocks": [{ "type": "text" }]
}

You would configure that like this: