webhooks

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-webhooks"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/4870b1c4-ef67-427a-9cf5-cfc37c3c2402/social-card.svg?v=3e7ae33eec8b" alt="webhooks" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/webhooks/deliveries/{id}/replay

Parameters

idstringpathrequired

Code samples

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

Responses

202 Default Response
Example
{
  "id": "string",
  "endpointId": "string",
  "outboxId": "string",
  "topic": "string",
  "attempt": 0,
  "status": "pending",
  "responseCode": 0,
  "latencyMs": 0,
  "error": "string",
  "nextAttemptAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
endpointIdstringrequired
outboxIdstringrequired
topicstringrequired
attemptintegerrequired
statusstringrequired
pending | succeeded | failed
responseCodeintegerrequired
latencyMsintegerrequired
errorstringrequired
nextAttemptAtstringrequired
createdAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
GEThttps://hermeticor.com/v1/webhook-templates

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/webhook-templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "url": "",
      "method": "POST",
      "headers": {},
      "body": null,
      "authHeaders": [],
      "description": "",
      "inputs": [],
      "outputs": [],
      "kind": "webhook",
      "status": "published",
      "labels": {},
      "executionRules": [],
      "code": null,
      "preActionCode": null,
      "allowedHosts": [],
      "secretNames": [],
      "timeoutMs": 5000,
      "memoryMb": 64,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem70[]required
Show child parameters
idstringrequired
namestringrequired
urlstringrequired
methodstringrequired
POST | PUT | PATCH | DELETE | GET | HEAD | OPTIONS = POST
headersobjectrequired
= {}
bodyobjectrequired
= null
authHeadersAuthHeadersItem2[]required
= []
Show child parameters
headerstringrequired
secretNamestringrequired
prefixstring
descriptionstringrequired
inputsInputsItem[]required
= []
Show child parameters
keystringrequired
labelstringrequired
requiredbooleanrequired
= false
typestringrequired
string | number | boolean | date | enum = string
optionsstring[]
optionsUrlstring
propertystring
labelsobject
outputsOutputsItem[]required
= []
Show child parameters
pathstringrequired
fieldstringrequired
labelstring
typestring
string | number | boolean | date
labelsobject
kindstringrequired
webhook | code = webhook
statusstringrequired
draft | published | archived = published
labelsobjectrequired
= {}
executionRulesExecutionRulesItem[]required
= []
Show child parameters
pathstringrequired
opstringrequired
eq | neq | exists | gt | lt
value
statestringrequired
SUCCESS | FAIL_CONTINUE | BLOCK
messagestringrequired
codestringrequired
= null
preActionCodestringrequired
= null
allowedHostsstring[]required
= []
secretNamesstring[]required
= []
timeoutMsintegerrequired
= 5000
memoryMbintegerrequired
= 64
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
POSThttps://hermeticor.com/v1/webhook-templates

Request body

application/json
namestringrequired
urlstring
methodstring
POST | PUT | PATCH | DELETE | GET | HEAD | OPTIONS = POST
headersobject
= {}
bodyobject
= null
authHeadersAuthHeadersItem[]
= []
Show child parameters
headerstringrequired
secretNamestringrequired
prefixstring
descriptionstring
inputsInputsItem2[]
= []
Show child parameters
keystringrequired
labelstringrequired
requiredboolean
= false
typestring
string | number | boolean | date | enum = string
optionsstring[]
optionsUrlstring
propertystring
labelsobject
outputsOutputsItem2[]
= []
Show child parameters
pathstringrequired
fieldstringrequired
labelstring
typestring
string | number | boolean | date
labelsobject
kindstring
webhook | code = webhook
statusstring
draft | published | archived = published
labelsobject
= {}
executionRulesExecutionRulesItem2[]
= []
Show child parameters
pathstringrequired
opstringrequired
eq | neq | exists | gt | lt
value
statestringrequired
SUCCESS | FAIL_CONTINUE | BLOCK
messagestringrequired
codestring
= null
preActionCodestring
= null
allowedHostsstring[]
= []
secretNamesstring[]
= []
timeoutMsinteger
= 5000
memoryMbinteger
= 64
{
  "name": "string",
  "url": "",
  "method": "POST",
  "headers": {},
  "body": null,
  "authHeaders": [],
  "description": "",
  "inputs": [],
  "outputs": [],
  "kind": "webhook",
  "status": "published",
  "labels": {},
  "executionRules": [],
  "code": null,
  "preActionCode": null,
  "allowedHosts": [],
  "secretNames": [],
  "timeoutMs": 5000,
  "memoryMb": 64
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhook-templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","url":"","method":"POST","headers":{},"body":null,"authHeaders":[],"description":"","inputs":[],"outputs":[],"kind":"webhook","status":"published","labels":{},"executionRules":[],"code":null,"preActionCode":null,"allowedHosts":[],"secretNames":[],"timeoutMs":5000,"memoryMb":64}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "url": "",
  "method": "POST",
  "headers": {},
  "body": null,
  "authHeaders": [],
  "description": "",
  "inputs": [],
  "outputs": [],
  "kind": "webhook",
  "status": "published",
  "labels": {},
  "executionRules": [],
  "code": null,
  "preActionCode": null,
  "allowedHosts": [],
  "secretNames": [],
  "timeoutMs": 5000,
  "memoryMb": 64,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
urlstringrequired
methodstringrequired
POST | PUT | PATCH | DELETE | GET | HEAD | OPTIONS = POST
headersobjectrequired
= {}
bodyobjectrequired
= null
authHeadersAuthHeadersItem2[]required
= []
Show child parameters
headerstringrequired
secretNamestringrequired
prefixstring
descriptionstringrequired
inputsInputsItem[]required
= []
Show child parameters
keystringrequired
labelstringrequired
requiredbooleanrequired
= false
typestringrequired
string | number | boolean | date | enum = string
optionsstring[]
optionsUrlstring
propertystring
labelsobject
outputsOutputsItem[]required
= []
Show child parameters
pathstringrequired
fieldstringrequired
labelstring
typestring
string | number | boolean | date
labelsobject
kindstringrequired
webhook | code = webhook
statusstringrequired
draft | published | archived = published
labelsobjectrequired
= {}
executionRulesExecutionRulesItem[]required
= []
Show child parameters
pathstringrequired
opstringrequired
eq | neq | exists | gt | lt
value
statestringrequired
SUCCESS | FAIL_CONTINUE | BLOCK
messagestringrequired
codestringrequired
= null
preActionCodestringrequired
= null
allowedHostsstring[]required
= []
secretNamesstring[]required
= []
timeoutMsintegerrequired
= 5000
memoryMbintegerrequired
= 64
createdAtstringrequired
updatedAtstringrequired
GEThttps://hermeticor.com/v1/webhook-templates/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/webhook-templates

Updated