Skip to content

Get an endpoint

GET
/v1/endpoints/{id}

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Path Parameters

id*
Type
string
Required

Responses

The endpoint, with its computed receive url + domain.

application/json
JSON
{
  
"id": "ep_01JX9",
  
"slug": "shopify-store",
  
"path": "/orders",
  
"name": "Shopify orders",
  
"preset": "shopify",
  
"url": "https://wh.emhk.in/acme/shopify-store/orders",
  
"domain": {
  
  
"id": "pdom_wh_emhk_in",
  
  
"host": "wh.emhk.in",
  
  
"kind": "platform"
  
},
  
"destinations": [
  
  
"string"
  
],
  
"responseRules": {
  
  
"rules": [
  
  
  
{
  
  
  
  
"when": {
  
  
  
  
  
"type": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"path": "string",
  
  
  
  
  
"op": "string",
  
  
  
  
  
"value": "string",
  
  
  
  
  
"all": [
  
  
  
  
  
  
{
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"any": [
  
  
  
  
  
  
{
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"not": "[Circular Reference]"
  
  
  
  
},
  
  
  
  
"respond": {
  
  
  
  
  
"status": 201,
  
  
  
  
  
"body": "{"pong":true}",
  
  
  
  
  
"headers": {
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"default": {
  
  
  
"status": 201,
  
  
  
"body": "{"pong":true}",
  
  
  
"headers": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
}
  
},
  
"responseProxy": {
  
  
"target": "managed",
  
  
"code": "string",
  
  
"url": "string",
  
  
"timeoutMs": 0,
  
  
"onUnavailable": "string"
  
},
  
"transform": {
  
  
"engine": "managed",
  
  
"code": "string",
  
  
"url": "string",
  
  
"failMode": "string",
  
  
"timeoutMs": 0
  
},
  
"response": {
  
  
"type": "meta-challenge",
  
  
"verifyToken": "string",
  
  
"secret": "string",
  
  
"verificationToken": "string",
  
  
"endpointUrl": "string",
  
  
"status": 0,
  
  
"body": "string",
  
  
"headers": {
  
  
  
"additionalProperties": "string"
  
  
}
  
},
  
"verification": "hmac-sha256",
  
"status": "active"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product