Create destination

post/v1/environments/{environmentId}/destinations

Page View

Destination endpoints allow you to manage destinations in a specified environment.

Dataset tester

Alternatively, you can run Dataset Tester to verify destinations.

You must be a member of the environment and be assigned to an engineer role to manage destinations. Learn about roles.

Create destination

Create a new destination in the specified environment.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/destinations' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
  "name": "string",
9
  "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91",
10
  "endpoint": "string",
11
  "environment": {
12
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
13
    "environmentFlag": "Staging"
14
  },
15
  "cloudProviderSettings": {
16
    "typeId": "azure",
17
    "productId": "databricks",
18
    "settings": {
19
      "containerName": "string",
20
      "fileNamePrefix": "string",
21
      "storageAccountName": "string"
22
    }
23
  },
24
  "setupState": {
25
    "step": "string",
26
    "destination": {
27
      "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91",
28
      "cloudProviderSettings": {},
29
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
30
      "name": "string",
31
      "environment": {
32
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33
        "environmentFlag": "Staging"
34
      }
35
    }
36
  },
37
  "verificationToken": "string"
38
}'

Request Body Schema

Contains an instance of a destination.

name
required, string
Displays the human-readable name of the endpoint that will receive messages from Redox.
id
string
Displays the unique identifier of the endpoint that will receive messages from Redox.
Format: uuid
authCredential
string
Displays the unique identifier of the destination's attached auth credential, if any.
Format: uuid
endpoint
string
Contains the URL of the endpoint that will receive messages from Redox. Production and staging applications must use HTTPS.
environment
object
Contains metadata about the environment within the associated Redox organization.
- id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
- environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development

cloudProviderSettings

Contains all the relevant configuration fields for the selected cloud provider and cloud product(s).

One of:

Contains the configuration details for a Microsoft Azure + Databricks destination.

typeId

string

Specifies the cloud provider (i.e., Azure).

Value: azure

productId

string

Specifies the cloud product being used with Azure.

Value: databricks

settings

object

Contains the configuration details for Microsoft Azure.

containerName
string
Defines the name of the container created in Azure.
fileNamePrefix
string
Provides a prefix to prepend to new files when they're created in Azure. Add / to put files in a subdirectory.
storageAccountName
string
Defines the name of the storage account created in Azure.

setupState
nullable, object
Describe the current setup state of the destination being configured
- step
  string
  The current step a user is on in the configuration process
- destination
  object
  The state of the current step in the configuration process
  authCredential
  nullable, string
  Displays the unique identifier of the destination's attached auth credential, if any.
  Format: uuid
  cloudProviderSettings
  nullable, object
  id
  nullable, string
  Displays the unique identifier of the endpoint that will receive messages from Redox.
  Format: uuid
  name
  nullable, string
  Displays the human-readable name of the endpoint that will receive messages from Redox.
  environment
  nullable, object
  Contains metadata about the environment within the associated Redox organization.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development
verificationToken
string
Contains the unique value that Redox sends in the message header to authenticate itself to a destination.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "destination": {
7
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
8
      "name": "string",
9
      "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91",
10
      "endpoint": "string",
11
      "environment": {
12
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
13
        "environmentFlag": "Staging"
14
      },
15
      "cloudProviderSettings": {
16
        "typeId": "azure",
17
        "productId": "databricks",
18
        "settings": {
19
          "containerName": "string",
20
          "fileNamePrefix": "string",
21
          "storageAccountName": "string"
22
        }
23
      },
24
      "setupState": {
25
        "step": "string",
26
        "destination": {
27
          "authCredential": "95dc8346-96b6-4721-88bf-bd96d3ac7a91",
28
          "cloudProviderSettings": {},
29
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
30
          "name": "string",
31
          "environment": {
32
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
33
            "environmentFlag": "Staging"
34
          }
35
        }
36
      }
37
    }
38
  }
39
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
payload
object
Contains the payload with details about the requested destination.
- destination
  object
  Contains an instance of a destination.
  id
  string
  Displays the unique identifier of the endpoint that will receive messages from Redox.
  Format: uuid
  name
  string
  Displays the human-readable name of the endpoint that will receive messages from Redox.
  authCredential
  string
  Displays the unique identifier of the destination's attached auth credential, if any.
  Format: uuid
  endpoint
  string
  Contains the URL of the endpoint that will receive messages from Redox. Production and staging applications must use HTTPS.
  environment
  object
  Contains metadata about the environment within the associated Redox organization.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development
  cloudProviderSettings
  Contains all the relevant configuration fields for the selected cloud provider and cloud product(s).
  One of:
  Contains the configuration details for a Microsoft Azure + Databricks destination.
  typeId
  string
  Specifies the cloud provider (i.e., Azure).
  Value: azure
  productId
  string
  Specifies the cloud product being used with Azure.
  Value: databricks
  settings
  object
  Contains the configuration details for Microsoft Azure.
  containerName
  string
  Defines the name of the container created in Azure.
  fileNamePrefix
  string
  Provides a prefix to prepend to new files when they're created in Azure. Add / to put files in a subdirectory.
  storageAccountName
  string
  Defines the name of the storage account created in Azure.
  setupState
  nullable, object
  Describe the current setup state of the destination being configured
  step
  string
  The current step a user is on in the configuration process
  destination
  object
  The state of the current step in the configuration process
  authCredential
  nullable, string
  Displays the unique identifier of the destination's attached auth credential, if any.
  Format: uuid
  cloudProviderSettings
  nullable, object
  id
  nullable, string
  Displays the unique identifier of the endpoint that will receive messages from Redox.
  Format: uuid
  name
  nullable, string
  Displays the human-readable name of the endpoint that will receive messages from Redox.
  environment
  nullable, object
  Contains metadata about the environment within the associated Redox organization.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  environmentFlag
  string
  Indicates whether the environment is used for development, staging, or production.
  Possible Values: Production, Staging, Development

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.