embeds

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-embeds"><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/b254a28f-f717-4d18-9b46-c8bcabb6d7ff/social-card.svg?v=3e7ae33eec8b" alt="embeds" width="600" height="315"></a>
POSThttps://hermetica.15.204.158.166.sslip.io/v1/embeds

Signed, expiring link to embed a read-only segment or journey view in another site (only the given origin may frame it)

Request body

application/json
kindstringrequired
segment | workflow
idstringrequired
originstringrequired
ttlMinutesinteger
= 60
{
  "kind": "segment",
  "id": "string",
  "origin": "string",
  "ttlMinutes": 60
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/embeds" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"segment","id":"string","origin":"string","ttlMinutes":60}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "url": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
urlstringrequired
expiresAtstringrequired
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/embeds

GEThttps://hermetica.15.204.158.166.sslip.io/p/embed/{token}

Embedded read-only segment or journey view

Parameters

tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/p/embed/{token}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

POSThttps://hermetica.15.204.158.166.sslip.io/v1/embeds/editors

Signed, expiring link that embeds the template editor, the journey editor or the deliveries table in another site (only the given origin may frame it)

Request body

application/json
kindstringrequired
template_editor | journey_editor | deliveries
idstring
originstringrequired
modestring
view | edit = edit
ttlMinutesinteger
= 60
{
  "kind": "template_editor",
  "id": "string",
  "origin": "string",
  "mode": "edit",
  "ttlMinutes": 60
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/embeds/editors" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"template_editor","id":"string","origin":"string","mode":"edit","ttlMinutes":60}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "url": "string",
  "token": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
urlstringrequired
tokenstringrequired
expiresAtstringrequired
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

GEThttps://hermetica.15.204.158.166.sslip.io/v1/embed-api/frame-policy

Internal: frame-ancestors for the web embed page, from the token in x-embed-token

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/embed-api/frame-policy"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204 Default Response
null
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

GEThttps://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template

Parameters

tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "workspaceId": "string",
  "channel": "email",
  "name": "string",
  "kind": "blocks",
  "folder": "string",
  "tags": [
    "string"
  ],
  "currentVersionId": "string",
  "archived": true,
  "folderId": "string",
  "brandKitId": "string",
  "isDefault": false,
  "topicId": null,
  "createdBy": null,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "currentVersion": {
    "id": "string",
    "templateId": "string",
    "workspaceId": "string",
    "body": {
      "kind": "blocks",
      "doc": {
        "version": 1,
        "width": 600,
        "background": "string",
        "blocks": [
          {}
        ],
        "translations": {}
      }
    },
    "subject": "string",
    "preheader": "string",
    "fromNameOverride": "string",
    "textBody": "string",
    "approvalStatus": "none",
    "reviewComment": "string",
    "createdBy": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "approvedBy": "string",
    "approvedAt": "2024-01-01T00:00:00Z",
    "fromEmail": null,
    "replyTo": null,
    "cc": []
  },
  "editable": true
}
Schema
idstringrequired
workspaceIdstringrequired
channelstringrequired
email | sms | whatsapp | push | postcard
namestringrequired
kindstringrequired
blocks | html | text | sms
folderstringrequired
tagsstring[]required
currentVersionIdstringrequired
archivedbooleanrequired
folderIdstringrequired
brandKitIdstringrequired
isDefaultbooleanrequired
= false
topicIdstringrequired
= null
createdBystringrequired
= null
createdAtstringrequired
updatedAtstringrequired
currentVersionobjectrequired
Show child parameters
idstringrequired
templateIdstringrequired
workspaceIdstringrequired
bodyobjectrequired
subjectstringrequired
preheaderstringrequired
fromNameOverridestringrequired
textBodystringrequired
approvalStatusstringrequired
none | pending | approved | rejected
reviewCommentstringrequired
createdBystringrequired
createdAtstringrequired
approvedBystringrequired
approvedAtstringrequired
fromEmailstringrequired
= null
replyTostringrequired
= null
ccstring[]required
= []
editablebooleanrequired
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

GEThttps://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template/versions

Parameters

limitintegerquery
= 50
cursorstringquery
tokenstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template/versions"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "templateId": "string",
      "workspaceId": "string",
      "body": {
        "kind": "blocks",
        "doc": {
          "version": 1,
          "width": 600,
          "background": "string",
          "blocks": [
            {}
          ],
          "translations": {}
        }
      },
      "subject": "string",
      "preheader": "string",
      "fromNameOverride": "string",
      "textBody": "string",
      "approvalStatus": "none",
      "reviewComment": "string",
      "createdBy": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "approvedBy": "string",
      "approvedAt": "2024-01-01T00:00:00Z",
      "fromEmail": null,
      "replyTo": null,
      "cc": []
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
templateIdstringrequired
workspaceIdstringrequired
bodyobjectrequired
subjectstringrequired
preheaderstringrequired
fromNameOverridestringrequired
textBodystringrequired
approvalStatusstringrequired
none | pending | approved | rejected
reviewCommentstringrequired
createdBystringrequired
createdAtstringrequired
approvedBystringrequired
approvedAtstringrequired
fromEmailstringrequired
= null
replyTostringrequired
= null
ccstring[]required
= []
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

POSThttps://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template/versions

Parameters

tokenstringpathrequired

Request body

application/json
bodyobjectrequired
subjectstring
= null
preheaderstring
= null
fromNameOverridestring
= null
textBodystring
= null
fromEmailstring
replyTostring
ccstring[]
{
  "body": {
    "kind": "blocks",
    "doc": {
      "version": 1,
      "width": 600,
      "background": "string",
      "blocks": [
        {}
      ],
      "translations": {}
    }
  },
  "subject": null,
  "preheader": null,
  "fromNameOverride": null,
  "textBody": null,
  "fromEmail": "string",
  "replyTo": "string",
  "cc": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/embed-api/{token}/template/versions" \
  -H "Content-Type: application/json" \
  -d '{"body":{"kind":"blocks","doc":{"version":1,"width":600,"background":"string","blocks":[{}],"translations":{}}},"subject":null,"preheader":null,"fromNameOverride":null,"textBody":null,"fromEmail":"string","replyTo":"string","cc":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "templateId": "string",
  "workspaceId": "string",
  "body": {
    "kind": "blocks",
    "doc": {
      "version": 1,
      "width": 600,
      "background": "string",
      "blocks": [
        {}
      ],
      "translations": {}
    }
  },
  "subject": "string",
  "preheader": "string",
  "fromNameOverride": "string",
  "textBody": "string",
  "approvalStatus": "none",
  "reviewComment": "string",
  "createdBy": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "approvedBy": "string",
  "approvedAt": "2024-01-01T00:00:00Z",
  "fromEmail": null,
  "replyTo": null,
  "cc": []
}
Schema
idstringrequired
templateIdstringrequired
workspaceIdstringrequired
bodyobjectrequired
subjectstringrequired
preheaderstringrequired
fromNameOverridestringrequired
textBodystringrequired
approvalStatusstringrequired
none | pending | approved | rejected
reviewCommentstringrequired
createdBystringrequired
createdAtstringrequired
approvedBystringrequired
approvedAtstringrequired
fromEmailstringrequired
= null
replyTostringrequired
= null
ccstring[]required
= []
4XX Default Response

Same as 4XX · POST /v1/embeds

5XX Default Response

Same as 4XX · POST /v1/embeds

Updated