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>
GEThttps://hermeticor.com/v1/webhooks/journal/exports/{id}

Status with progress and error; downloadUrl is set once the job is completed

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
bulk | export
opstringrequired
statusstringrequired
queued | running | completed | failed
progressobjectrequired
Show child parameters
totalintegerrequired
processedintegerrequired
failedintegerrequired
errorstringrequired
downloadUrlstring
failuresFailuresItem[]
Show child parameters
profileIdstringrequired
messagestringrequired
createdAtstringrequired
finishedAtstringrequired
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/webhooks/journal/exports/{id}

POSThttps://hermeticor.com/v1/integrations/google/start

Start a Google sign-in that saves a Sheets grant under the named secret; the access token is refreshed automatically

Request body

application/json
secretNamestringrequired
{
  "secretName": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/integrations/google/start" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"secretName":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string"
}
Schema
urlstringrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

5XX Default Response

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

GEThttps://hermeticor.com/v1/integrations/google/callback

Parameters

codestringquery
statestringquery
errorstringquery
error_descriptionstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/integrations/google/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

5XX Default Response

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

POSThttps://hermeticor.com/webhooks/shopify/{topic}

Shopify compliance webhook (data request, customer or shop redact); 401 unless signed with the app secret

Parameters

topicstringpathrequired
customers-data-request | customers-redact | shop-redact

Code samples

cURL
curl -X POST "https://hermeticor.com/webhooks/shopify/{topic}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

5XX Default Response

Same as 4XX · GET /v1/webhooks/journal/exports/{id}

Updated