destinations

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-destinations"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/316e0607-c8cb-46a9-9de8-c3a4f6ff0532/social-card.svg?v=3e7ae33eec8b" alt="destinations" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/destinations

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/destinations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kind": "webhook",
      "name": "string",
      "config": {},
      "mapping": {
        "identify": true,
        "track": true,
        "events": [
          "string"
        ],
        "rename": {},
        "denyProperties": [
          "string"
        ],
        "traits": [
          "string"
        ]
      },
      "enabled": true,
      "sentCount": 0,
      "failedCount": 0,
      "droppedCount": 0,
      "lastSentAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem243[]required
Show child parameters
idstringrequired
kindstringrequired
webhook | mixpanel | amplitude | ga4 | bigquery
namestringrequired
configobjectrequired
mappingobjectrequired
Show child parameters
identifybooleanrequired
trackbooleanrequired
eventsstring[]required
renameobjectrequired
denyPropertiesstring[]required
traitsstring[]required
enabledbooleanrequired
sentCountintegerrequired
failedCountintegerrequired
droppedCountintegerrequired
lastSentAtstringrequired
lastErrorstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/destinations

POSThttps://hermeticor.com/v1/destinations

Add a destination; profiles that opted out of tracking are never forwarded

Request body

application/json
kindstringrequired
webhook | mixpanel | amplitude | ga4 | bigquery
namestringrequired
configobject
= {}
credentialsobjectrequired
mappingobject
Show child parameters
identifyboolean
trackboolean
eventsstring[]
renameobject
denyPropertiesstring[]
traitsstring[]
{
  "kind": "webhook",
  "name": "string",
  "config": {},
  "credentials": {},
  "mapping": {
    "identify": true,
    "track": true,
    "events": [
      "string"
    ],
    "rename": {},
    "denyProperties": [
      "string"
    ],
    "traits": [
      "string"
    ]
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/destinations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"webhook","name":"string","config":{},"credentials":{},"mapping":{"identify":true,"track":true,"events":["string"],"rename":{},"denyProperties":["string"],"traits":["string"]}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "kind": "webhook",
  "name": "string",
  "config": {},
  "mapping": {
    "identify": true,
    "track": true,
    "events": [
      "string"
    ],
    "rename": {},
    "denyProperties": [
      "string"
    ],
    "traits": [
      "string"
    ]
  },
  "enabled": true,
  "sentCount": 0,
  "failedCount": 0,
  "droppedCount": 0,
  "lastSentAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
webhook | mixpanel | amplitude | ga4 | bigquery
namestringrequired
configobjectrequired
mappingobjectrequired
Show child parameters
identifybooleanrequired
trackbooleanrequired
eventsstring[]required
renameobjectrequired
denyPropertiesstring[]required
traitsstring[]required
enabledbooleanrequired
sentCountintegerrequired
failedCountintegerrequired
droppedCountintegerrequired
lastSentAtstringrequired
lastErrorstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

GEThttps://hermeticor.com/v1/destinations/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/destinations/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/destinations

4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

DELETEhttps://hermeticor.com/v1/destinations/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/destinations/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

PATCHhttps://hermeticor.com/v1/destinations/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
enabledboolean
configobject
credentialsobject
mappingobject
Show child parameters
identifyboolean
trackboolean
eventsstring[]
renameobject
denyPropertiesstring[]
traitsstring[]
{
  "name": "string",
  "enabled": true,
  "config": {},
  "credentials": {},
  "mapping": {
    "identify": true,
    "track": true,
    "events": [
      "string"
    ],
    "rename": {},
    "denyProperties": [
      "string"
    ],
    "traits": [
      "string"
    ]
  }
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/destinations/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","enabled":true,"config":{},"credentials":{},"mapping":{"identify":true,"track":true,"events":["string"],"rename":{},"denyProperties":["string"],"traits":["string"]}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/destinations

4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

POSThttps://hermeticor.com/v1/destinations/{id}/test

Send one test event to the destination

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/destinations/{id}/test" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true,
  "message": "string"
}
Schema
okbooleanrequired
messagestringrequired
4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

GEThttps://hermeticor.com/v1/destinations/{id}/deliveries

Recent deliveries with their status and last error

Parameters

limitintegerquery
= 50
cursorstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/destinations/{id}/deliveries" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "status": "pending",
      "attempts": 0,
      "lastError": "string",
      "sentAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "type": "string",
      "event": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
keystringrequired
statusstringrequired
pending | sent | failed | dropped
attemptsintegerrequired
lastErrorstringrequired
sentAtstringrequired
createdAtstringrequired
typestringrequired
eventstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/destinations

5XX Default Response

Same as 4XX · GET /v1/destinations

Updated