ads

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-ads"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c2535669-01a3-482f-a371-11a539962017/social-card.svg?v=3e7ae33eec8b" alt="ads" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/ads/oauth/apps

Which ad platforms can be connected by sign-in on this install

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "platform": "meta",
      "configured": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
platformstringrequired
meta | google | tiktok | snapchat | pinterest | linkedin
configuredbooleanrequired
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/ads/oauth/apps

POSThttps://hermeticor.com/v1/ads/oauth/{platform}/start

Start the sign-in: returns the platform authorize URL (state is bound to this workspace and user)

Parameters

platformstringpathrequired
meta | google | tiktok | snapchat | pinterest | linkedin

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/ads/oauth/{platform}/start" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

GEThttps://hermeticor.com/integrations/ads/{platform}/callback

Parameters

typequery
additionalPropertiesstringquery
platformstringpathrequired
meta | google | tiktok | snapchat | pinterest | linkedin

Code samples

cURL
curl -X GET "https://hermeticor.com/integrations/ads/{platform}/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

GEThttps://hermeticor.com/v1/ads/oauth/pending/{id}

Ad accounts available after sign-in

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "id": "string",
  "platform": "meta",
  "accounts": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}
Schema
idstringrequired
platformstringrequired
meta | google | tiktok | snapchat | pinterest | linkedin
accountsobject[]required
Show child parameters
idstringrequired
namestringrequired
4XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

POSThttps://hermeticor.com/v1/ads/oauth/pending/{id}/finish

Connect the chosen ad account

Parameters

idstringpathrequired

Request body

application/json
externalIdstringrequired
namestring
configobject
Show child parameters
pixelIdstring
pixelCodestring
loginCustomerIdstring
apiVersionstring
{
  "externalId": "string",
  "name": "string",
  "config": {
    "pixelId": "string",
    "pixelCode": "string",
    "loginCustomerId": "string",
    "apiVersion": "string"
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/ads/oauth/pending/{id}/finish" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"string","name":"string","config":{"pixelId":"string","pixelCode":"string","loginCustomerId":"string","apiVersion":"string"}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "platform": "meta",
  "name": "string",
  "externalId": "string",
  "config": {},
  "status": "string",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
platformstringrequired
meta | google | tiktok | snapchat | pinterest | linkedin
namestringrequired
externalIdstringrequired
configobjectrequired
statusstringrequired
lastErrorstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

GEThttps://hermeticor.com/webhooks/ads/meta/leadgen

Meta leadgen webhook verification handshake

Parameters

typequery
additionalPropertiesstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/webhooks/ads/meta/leadgen"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

POSThttps://hermeticor.com/webhooks/ads/meta/leadgen

Meta leadgen delivery: queues the matching lead form syncs at once

Code samples

cURL
curl -X POST "https://hermeticor.com/webhooks/ads/meta/leadgen"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · GET /v1/ads/oauth/apps

5XX Default Response

Same as 4XX · GET /v1/ads/oauth/apps

Updated