hooks

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-hooks"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/24ff2d04-2cab-47db-8e97-44bbed4d9e7e/social-card.svg?v=3e7ae33eec8b" alt="hooks" width="600" height="315"></a>
POSThttps://hermetica.15.204.158.166.sslip.io/v1/hooks/subscribe

Subscribe a Zapier/Make REST hook to a trigger

Request body

application/json
triggerstringrequired
new_reply | profile_created | campaign_sent
targetUrlstringrequired
{
  "trigger": "new_reply",
  "targetUrl": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/hooks/subscribe" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"trigger":"new_reply","targetUrl":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "url": "string",
  "topics": [
    "string"
  ],
  "description": "string",
  "filters": [
    {
      "id": "string",
      "path": "string",
      "op": "eq",
      "value": {}
    }
  ],
  "listIds": [
    "string"
  ],
  "sources": [
    "string"
  ],
  "sequenceIds": [
    "string"
  ],
  "bodyTemplate": "string",
  "authHeaders": [
    {
      "header": "string",
      "secretName": "string",
      "prefix": "string"
    }
  ],
  "throttleSeconds": 0,
  "throttleTopics": [
    "string"
  ],
  "status": "active",
  "consecutiveFailures": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "secret": "string"
}
Schema
idstringrequired
urlstringrequired
topicsstring[]required
descriptionstringrequired
filtersobject[]required
Show child parameters
idstring
pathstringrequired
opstringrequired
eq | neq | in | contains | exists | gt | lt
value
listIdsstring[]required
sourcesstring[]required
sequenceIdsstring[]required
bodyTemplatestringrequired
authHeadersobject[]required
Show child parameters
headerstringrequired
secretNamestringrequired
prefixstring
throttleSecondsintegerrequired
throttleTopicsstring[]required
statusstringrequired
active | disabled
consecutiveFailuresintegerrequired
createdAtstringrequired
updatedAtstringrequired
secretstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/hooks/subscribe

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/hooks/{id}

Unsubscribe a REST hook

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/hooks/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · POST /v1/hooks/subscribe

5XX Default Response

Same as 4XX · POST /v1/hooks/subscribe

GEThttps://hermetica.15.204.158.166.sslip.io/v1/hooks/triggers/{trigger}/sample

Sample payload used by Zapier/Make to map fields

Parameters

triggerstringpathrequired
new_reply | profile_created | campaign_sent

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/hooks/triggers/{trigger}/sample" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
[
  {}
]
4XX Default Response

Same as 4XX · POST /v1/hooks/subscribe

5XX Default Response

Same as 4XX · POST /v1/hooks/subscribe

Updated