Home
API reference
Platform API reference
Platform API
Destinations
Verify destination

Verify destination

post/v1/destinations/{destinationId}/verify
Page View

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

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

Verify destination

Update your destination URL and verification token. Then, verify that communication can be established between Redox and the destination.

If successful, the destination is marked as verified and ready to receive data. The endpoint, verificationToken, and verificationMethod must either already be set for the destination or sent as part of this request.

You can also verify a destination in the Redox dashboard. Learn how to create and verify an endpoint.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/destinations/{destinationId}/verify' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "endpoint": "string",
8
  "verificationToken": "string",
9
  "verificationMethod": "POST"
10
}'

Path Parameters

  • environmentId
    required, string

    Identifies the specific environment that you're operating in or on behalf of.

Request Body Schema

    Contains the fields that can be provided when verifying a destination.

  • endpoint
    string

    Contains the URL of the endpoint that will receive messages from Redox. Production and staging applications must use HTTPS.

  • verificationToken
    string

    Contains the unique value that Redox sends in the message header to authenticate itself to a destination.

  • verificationMethod
    string

    HTTP method Redox will use when verifying the destination.

    Possible Values: GET, POST

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
      "environment": {
11
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
12
        "environmentFlag": "Staging"
13
      },
14
      "endpoint": "string",
15
      "verificationToken": "string",
16
      "verificationMethod": "POST",
17
      "verified": true
18
    }
19
  }
20
}
  • 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 details about the destination and its verification status.

      • 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
      • 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
      • endpoint
        string

        Contains the URL of the endpoint that will receive messages from Redox. Production and staging applications must use HTTPS.

      • verificationToken
        string

        Contains the unique value that Redox sends in the message header to authenticate itself to a destination.

      • verificationMethod
        string

        HTTP method Redox will use when verifying the destination.

        Possible Values: GET, POST
      • verified
        boolean

        Indicates whether a destination has been successfully verified and can receive data.