We have a few one time setup requirements to configure domains on our SaaS solution.
\nThe domains named yourdomain.com are simply suggestions. Feel free to selected any
Staging Environment\nCNAME → beta.pages.yourdomain.com → staging.builder.convrrt.com
Production Environment\nCNAME → pages.yourdomain.com → production.builder.convrrt.com
CDN DNS\nThese domains are used to serve landing page traffic for your customers as well as give you a custom CNAME record that your customers can point to when they use custom domains.
NOTICE: Set up the next two CNAME records on a separate FQDN to minimize the risk of XSS and cluttering your primary domains SEO.
This first record will be used by your customers to attach their custom domains to websites.
\nCNAME → sites.yourdomain.net → sites.convrrt.zone
CNAME → *.sites.yourdomain.net → sites.convrrt.zone
The star (wildcard) subdomain will be used to resolve websites that do not have a custom domain but use an internal slug I.E (nike-x12tbs.sites.yourdomain.com)
\nWild Card Certificate\nLastly, we are not able to generate a certificate to secure this wild card domain. You will need to provide us with a certificate and private key.
\nYou will need a JSON Web Token library. You can find one for your language of choice here.\nThen we will provide you with a shared secret via pgp or keybase that you can sign your JWT with.\nYour developers will need to set the JWT token as a cookie on _pages_session → .yourdomain.com this way you can control their session as well as access resources using CORS in the browser and we can see it on the subdomain.
* = requiredExample JWT
\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"jeffy.dahmor@gmail.com\",\n \"orgID\": \"your-org-id\",\n \"projectID\": \"randomInternalGroupName\",\n \"userId\": \"80982a83-a7e9-5cea-85a9-2488f13ea6ff\"\n}\nNote: We may change from HMAC to RSA in the future using JSON Web Keys to encrypt JSON Web Tokens.
\nOnce the previous steps have been completed and the cookie is set on your domain. You can redirect the visitor to our system for a seamless integration.
\nIf the user is creating a new site send them here\nhttps://pages.yourdomain.com/choose-a-template
\nIf the user is attempting to edit an existing site send them here\nhttps://pages.yourdomain.com/editor/:siteId
\nTo ensure the user is able to get back to where they came from you can include a ?redirectUrl= parameter when you send them to convrrt. This way we can redirect them back when they are finished.
Once the cookie is set you can access resources in convrrt through CORS in the browser or the server to our API.
\nList all sites that belong to the current **appId**\nGET https://pages.yourdomain.com/api/v1/sites
You can use our API’s to build a custom dashboard for managing landing pages.\nAll our ID’s are uuidV4 so you can safely store them in your system for reference.\nJust remember they are scoped to the projectID set in the JWT.
Documentation\nhttps://developers.convrrt.com
\nOur system can publish critical events / data to your platform using webhook standards.\nOnce you supply us with an endpoint to deliver payloads to you will receive a POST message that includes an X-Event-Signature header.\nThe value of this header is calculated using this formula HMAC(algorithm='sha256', key='JWTSigningKey', payload='JSONEncodedBody', digest='hex').
Once subscribed the JSON payloads will be in this format.
\n{\n \"id\": \"ca9f95d4-806d-461a-bcad-5a7367ec30e8\",\n \"type\": \"form_submission\",\n \"orgID\": \"ORG_ID\",\n \"projectID\": \"PROJECT_ID\",\n \"userID\": \"USER_ID\",\n \"createdAt\": \"2019-03-27T12:53:58.635Z\",\n \"data\": {\n }\n}\nThe data value can vary based on type. projectID maps to the internal grouping you created for a subset of your users when setting the claims in your JWT. userID may or may not be populated with a known value unless you set that claim manually.
form_submission event{\n \"id\": \"ca9f95d4-806d-461a-bcad-5a7367ec30e8\",\n \"type\": \"form_submission\",\n \"orgID\": \"ORG_ID\",\n \"projectID\": \"PROJECT_ID\",\n \"userID\": \"USER_ID\",\n \"createdAt\": \"2019-03-27T12:53:58.635Z\",\n \"data\": {\n \"siteID\": \"3d945e54-9d14-436c-b345-34662b059caa\",\n \"fields\": [\n {\n \"id\": \"given_name\",\n \"value\": \"John\"\n },\n {\n \"id\": \"family_name\",\n \"value\": \"Doe\"\n },\n {\n \"id\": \"email\",\n \"value\": \"john.doe@yahoo.com\"\n },\n {\n \"id\": \"phone\",\n \"value\": \"+15417491245\"\n },\n {\n \"id\": \"0d733eb1-50ed-4726-97b8-19a0a750aff7\",\n \"value\": true\n }\n ]\n }\n}\nSign a user into the API server using a signed JWT. This will set a cookie on the users browser and redirect them to the editor.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","auth","login","jwt"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[]}},"response":[{"id":"575e53e4-0dbb-4b69-a288-7134ced992da","name":"Log a user in using a signed JWT /jot/","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://production.builder.convrrt.com/api/auth/login/jwt"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4a9315ba-3cc1-41b1-a7cb-b183ab983dfc"},{"name":"Current User","event":[{"listen":"test","script":{"id":"926337d0-9b46-481a-9bb4-14c0b0a1c5fc","exec":["postman.setNextRequest(null);"],"type":"text/javascript"}}],"id":"70824c82-a725-45b7-bc82-a867e6d16cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/auth/currentUser","description":"Get the details and configuration of the user associated with the Bearer token sent in the request or the current session.
This collection of URLs allows developers to acquire sessions for their users.
\n","_postman_id":"e6dc6329-c693-400d-aed2-af8ac0d560ef","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"/v1","item":[{"name":"/sites","item":[{"name":"/pages","item":[{"name":"/forms [DEPRECATED]","item":[{"name":"List forms by siteID and pageID","id":"aedb6a50-51cc-450e-8227-45123908ea19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages/:pageID/forms","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","pages",":pageID","forms"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to which the form belongs
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The UUID of the page to which the form blongs
\n","type":"text/plain"},"type":"string","value":"","key":"pageID"}]}},"response":[],"_postman_id":"aedb6a50-51cc-450e-8227-45123908ea19"},{"name":"Create a new logical form under a given siteID and pageID","id":"057903f3-b5fa-49f0-b928-00fe73e17846","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Contact Form\"\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages/:pageID/forms","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","pages",":pageID","forms"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to which the form belongs
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The UUID of the page to which the form belongs
\n","type":"text/plain"},"type":"string","value":"","key":"pageID"}]}},"response":[],"_postman_id":"057903f3-b5fa-49f0-b928-00fe73e17846"}],"id":"798cce60-b7bd-42fc-b892-0f8b341dcd32","description":"Manage the logical form objects belonging to a given siteID and pageID.\n[DEPRECATED]
\n","_postman_id":"798cce60-b7bd-42fc-b892-0f8b341dcd32","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"List all site pages","id":"75c590c5-c9ed-4999-aadb-c15a24098838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages","description":"List all the pages belonging to the siteID in the path parameters.
The UUID of the site
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"75c590c5-c9ed-4999-aadb-c15a24098838"},{"name":"Create a new site page","id":"c16c9d19-8375-4c86-a33f-042bfb7ca3a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"thank you\",\n \"isIndex\": false\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages","description":"Creates a new page within the site specified in the path parameters.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","pages"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to create the new page under
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"c16c9d19-8375-4c86-a33f-042bfb7ca3a3"},{"name":"Fetch page data by siteID and pageID","id":"2088d768-cdaa-4682-ad7f-6fa3e064fe0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages/:pageID","description":"Fetch page data by siteID and pageID in the path parameters.
The UUID of the site to fetch page data for
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The UUID of the page to fetch data for
\n","type":"text/plain"},"type":"string","value":"","key":"pageID"}]}},"response":[],"_postman_id":"2088d768-cdaa-4682-ad7f-6fa3e064fe0b"},{"name":"Update a page by siteID and pageID","id":"98086624-23cb-4437-90f1-dc02ccadeee2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Home Page\",\n \"embeds\": \"\",\n \"styles\": \".custom-css {}\",\n \"description\": \"This description will be embeded in the pages headers\"\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/pages/:pageID","description":"Modify the properties of a page by siteID and pageID
The UUID of the site the page belongs to
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The UUID of the page which belongs to the siteID
\n","type":"text/plain"},"type":"string","value":"","key":"pageID"}]}},"response":[],"_postman_id":"98086624-23cb-4437-90f1-dc02ccadeee2"},{"name":"Render an HTML preview of a page by its siteID and pageID","id":"cbff3312-a46f-4b55-8449-e418bd992188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/preview/:pageID","description":"The response from this operation can be used to display a preview of the given siteID and pageID. This is useful when allowing a user to view a WYSIWYG preview of the page before they publish their site to the CDN.
The UUID of the site to preview
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The UUID of the page to preview
\n","type":"text/plain"},"type":"string","value":"","key":"pageID"}]}},"response":[],"_postman_id":"cbff3312-a46f-4b55-8449-e418bd992188"}],"id":"3c7d6328-503e-44f9-b50a-1662ec2cfb5b","description":"Manage pages belonging to the given siteID.
\n","_postman_id":"3c7d6328-503e-44f9-b50a-1662ec2cfb5b","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"/domains","item":[{"name":"List custom domains by siteID","id":"dd61a4fa-d72b-4064-930e-33464818f1d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/domains","description":"List all domains attached to the given siteID.
The UUID of the site for which to fetch domain information
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"dd61a4fa-d72b-4064-930e-33464818f1d0"},{"name":"Attach custom domain to a site by siteID","id":"ff7b65f0-0ccb-40da-934f-8b22859d6852","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"my.custom.domain\"\n} "},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/domains","description":"Attach a custom domain to the siteID specified in the path parameters.\nThis endpoint will not respond with a 200 OK status unless the user has validated ownership of the root domain via a configurable DNS TXT record.
Contact support for more information on configuring this for your organization.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","domains"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to attach the new custom domain to
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"ff7b65f0-0ccb-40da-934f-8b22859d6852"},{"name":"Detach a custom domain from a site by siteID","id":"194f33d9-c99e-4a60-b9b8-bd00e681e877","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/domains/:domain","description":"Some customers may want to re-assign a custom domain to another site.\nTo do this they must first detach the domain from the site it currently belongs to.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","domains",":domain"],"host":["https://production.builder.convrrt.com"],"query":[{"disabled":true,"key":"domain","value":"test-fuckshit.convrrt.it"}],"variable":[{"description":{"content":"The UUID of the site from which to detach the given domain
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"},{"description":{"content":"The custom hostname to detach from the given siteID
\n","type":"text/plain"},"type":"string","value":"my.custom.domain","key":"domain"}]}},"response":[],"_postman_id":"194f33d9-c99e-4a60-b9b8-bd00e681e877"}],"id":"bc01429a-c92c-40c2-9772-91ff1052ed1f","description":"Manage custom domains attached to a site by siteID in the path parameters.
\n","_postman_id":"bc01429a-c92c-40c2-9772-91ff1052ed1f","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"List all sites the current user has access to","id":"63a358b7-1468-4662-9922-732445d8497c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://production.builder.convrrt.com/api/v1/sites?offset=0&limit=5&archived=false&market=false","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites"],"host":["https://production.builder.convrrt.com"],"query":[{"description":{"content":"The offset used to page through query results
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"The limit to use in combination with offset to page through the results
When true displays sites that were archived (marked as deleted) in the query results
\n","type":"text/plain"},"key":"archived","value":"false"},{"description":{"content":"Changes the display format of the query results for display in a marketplace. Useful when an account is used for creating templates that will be shared between accounts.
\n","type":"text/plain"},"key":"market","value":"false"}],"variable":[]}},"response":[],"_postman_id":"63a358b7-1468-4662-9922-732445d8497c"},{"name":"Create a new site","id":"bdf7e385-3249-4227-bd99-2168ec6309a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Site 3\"\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites","description":"Creates a new site belonging to the currently authenticated user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdf7e385-3249-4227-bd99-2168ec6309a3"},{"name":"Update site by siteID","id":"dba2d7ff-fe09-4600-9f79-1de197b77321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Site 33\",\n \"embeds\": \"\",\n \"styles\": \".custom-css-all-pages {}\",\n \"foreignData\": \"{ \\\"externalID\\\": \\\"fecf215a-b563-4128-a793-9ccb6cbc41c3\\\" }\"\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID","description":"Update a site by its siteID in the path parameters.
In some cases it may be useful to associate external data with a given site.\nFor example you may want to associate an internal identifier for a site with the sites ID in our system. To do this use the foreignData field which can store a string version of a JSON object containing any arbitrary data you like.
The UUID of the site to update apply the update to
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"dba2d7ff-fe09-4600-9f79-1de197b77321"},{"name":"Fetch a site by its siteID","id":"d404eb75-69f9-47a6-8e5a-d88a34735fa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to fetch
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"d404eb75-69f9-47a6-8e5a-d88a34735fa7"},{"name":"Archive a site by its siteID","id":"d3dfa74d-afff-49b9-830a-c6314351539e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Site 3\"\n}"},"url":"{{baseURL}}/api/v1/sites/:siteID","description":"Convrrt makes an active effort to prevent accidental deletion of data. This endpoint allows the user to archive a site and its sub resources. Archiving a site will result in a deletedAt timestamp being set on the site and all its resources being unpublished from the CDN.
Warning: This will cause the site to stop serving traffic.
\nIt can be restored using the unarchive operation.\nYou will still need to publish the site after it has been unarchived.
The UUID of the site which should be archived (marked as deleted)
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"d3dfa74d-afff-49b9-830a-c6314351539e"},{"name":"Publish a site by its siteID","id":"07849bb9-29f0-40f0-a575-284f731f3133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/publish","description":"Publishing a site causes its current state to be rendered into static HTML and deployed to our CDN.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","publish"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to publish to the CDN
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"07849bb9-29f0-40f0-a575-284f731f3133"},{"name":"Unpublish a site by its siteID","id":"334c7a03-0f77-4f60-a203-78eb84d1a6be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":""},"url":"{{baseURL}}/api/v1/sites/:siteID/publish","description":"Unpublishing a site will cause its static content to be removed from our CDN.
\nWarning: this will cause the site to stop serving traffic.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","publish"],"host":["{{baseURL}}"],"query":[],"variable":[{"description":{"content":"The UUID of the site to unpublish
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"334c7a03-0f77-4f60-a203-78eb84d1a6be"},{"name":"Clone site by siteID","id":"5d08b5d9-7520-49c9-b6cf-caa27c1828f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Name of my cloned site\"\n}"},"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/clone","description":"This operation allows the user to clone a site. This is useful when a user wants to re-use an existing site as a template for a new site.
\nThe POST body may override any existing properties of the site like (name).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","clone"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site which should be cloned
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"5d08b5d9-7520-49c9-b6cf-caa27c1828f3"},{"name":"Trigger site thumbnail update","id":"c0c94542-8bfc-4949-9795-591d6452da58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://production.builder.convrrt.com/api/v1/sites/:siteID/updateThumbnails","description":"This triggers an asynchronous process which takes a screenshot of the index page of the given siteID and updates its current thumbnail URL with the latest version. While the update is in process the sites thumbnail image is set to a temporary image indicating a thumbnail is rendering.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","sites",":siteID","updateThumbnails"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[{"description":{"content":"The UUID of the site to trigger a thumbnail update operation
\n","type":"text/plain"},"type":"string","value":"","key":"siteID"}]}},"response":[],"_postman_id":"c0c94542-8bfc-4949-9795-591d6452da58"},{"name":"Create from marketplace template","id":"06761e3f-2e3e-4e97-a2e1-78cb9f13860a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/v1/sites/fromTemplate/:templateID","description":"This operation allows you to use a marketplace templateID to create a new site. This is virtually identical to the clone operation.
The UUID of the template site to use as the base for the new site
\n","type":"text/plain"},"type":"string","value":"","key":"templateID"}]}},"response":[],"_postman_id":"06761e3f-2e3e-4e97-a2e1-78cb9f13860a"}],"id":"ce98aa3a-5173-484e-986b-af6b06d33926","description":"Manage resources belonging to sites built using the Convrrt landing page builder.
\n","_postman_id":"ce98aa3a-5173-484e-986b-af6b06d33926","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"/market","item":[{"name":"List marketplace templates","id":"30bed901-e2ee-4916-9641-3aba55f8064c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/v1/marketplace/templates","description":"This operation lets you query marketplace templates belonging to your organization. This is used when displaying pre-built tempaltes to the user in a marketplace screen. The IDs from this endpoint may be used to create new sites using the Create from marketplace template operation.
This endpoint requires a custom integration between Convrrt and your CRM.\nWith a custom integration Convrrt can allow the user to create custom contact fields directly in our interface and the data will be visible in the CRM. This also allows the form builder to use the newly created custom fields.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","crm","form","fields"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"70733d0f-43a1-4dd3-be1a-4127ad79aee0"},{"name":"List CRM form fields","id":"bb7e2fc1-ab3c-4efa-a75b-71e33878a2a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://production.builder.convrrt.com/api/v1/crm/form/fields","description":"This API requires a custom integration between convrrt and your CRM.\nWith a custom integration our system will pull data from your users CRM account and map it to fields that are available in the convrrt form builder.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}},"urlObject":{"path":["api","v1","crm","form","fields"],"host":["https://production.builder.convrrt.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb7e2fc1-ab3c-4efa-a75b-71e33878a2a8"}],"id":"9cee02cd-53d7-4440-88ca-b8c18b394b2e","description":"These APIs power the fields section of the form builder.
\n","_postman_id":"9cee02cd-53d7-4440-88ca-b8c18b394b2e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}}],"id":"42f8e1c2-e908-458f-8868-98ec48f6a666","description":"These APIs power the form builder.
\n","_postman_id":"42f8e1c2-e908-458f-8868-98ec48f6a666","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}}],"id":"bc8baf64-4cf5-470f-9767-d6bb41a618dd","description":"These API operations are for use by the Convrrt builder to power misc components like the form builder. Custom form fields and data tags from your CRM.
\n","_postman_id":"bc8baf64-4cf5-470f-9767-d6bb41a618dd","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}},{"name":"/organization","item":[{"name":"/admin","item":[{"name":"/projects","item":[{"name":"Deactivate project by projectID","id":"afca057c-5274-4f24-ade0-aaad2dc8c366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://production.builder.convrrt.com/api/v1/organization/admin/projects/:projectiD/deactivate","description":"This endpoint will unpublish / archive all resources that belong to a given projectID. This endpoint has a direct impact on your users. Please use it with caution. This endpoint should be used to control cost and automate the cancelation of resources in our platform.
NOTE this will cause all sites belonging to customers in the given projectID to stop serving traffic.
The external project identifier specificed in your JWT tokens that groups user resourecs
\n","type":"text/plain"},"type":"string","value":"","key":"projectiD"}]}},"response":[],"_postman_id":"afca057c-5274-4f24-ade0-aaad2dc8c366"},{"name":"Unarchive resources belonging to a given projectID","id":"b46e903b-769d-46d2-9380-aeb9932d1bd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://production.builder.convrrt.com/api/v1/organization/admin/projects/:projectID/sites/unarchiveAll?publish=true","description":"This endpoint will unarchive and optionally republish all resources belonging to the calling organization and projectID.
The external project identifier specificed in your JWT tokens that groups user resourecs
\n","type":"text/plain"},"type":"string","value":"","key":"projectID"}]}},"response":[],"_postman_id":"b46e903b-769d-46d2-9380-aeb9932d1bd1"}],"id":"62d4da04-c3bc-4d0e-8ac3-be37693a5d32","description":"These APIs provide bulk operations for projects (tenants) within Convrrt under your organization. Projects are synonymous to user groups within your system. They are a logical grouping of users from your platform into Convrrt.
\nIf you use a userID from your platform as the projectID resources will be scoped to only that user.
If you use a shared groupID from your system as a projectID all users who share the groupID in your platform will share access to resources in Convrrt.
These admin endpoints requires special privileges.\nYou can authenticate to this endpoint by sending API requests with signed JWT for your organization.
\nThe caveat is that you must supply an email address claim in the JWT which maps to an authorized administrative user.
\nPlease reach out over your customer support channel to have us authorize an email address.
\nWe recommend setting an email address which is secure and unobtainable by any user in your platform. We've seen customers use devops api admin @organization.com.
An example JWT claim would look like this.
\n{\n \"orgID\": \"YOUR_ORG_ID\",\n \"projectID\": \"YOUR_PROJECT_ID\",\n \"email\": \"admin@organization.com\"\n}\nOnce we have authorized that email to perform administrative actions calls to these endpoints should succeed.
\n","event":[{"listen":"prerequest","script":{"id":"480d7758-671f-4716-8c34-486b59368463","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1805cf03-ca77-4261-b924-a870adcf1336","type":"text/javascript","exec":[""]}}],"_postman_id":"02ce14f2-db8b-4fa8-8b25-90f6aeee507e","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}}],"id":"046cce22-91cb-4893-9ca1-fb840644ef66","description":"This API allows you to control settings for your organization.
\n","_postman_id":"046cce22-91cb-4893-9ca1-fb840644ef66","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}}],"id":"5f65e052-b33d-4cfa-a7b4-97cdf26d773f","description":"Version 1.0 of the builder API
\n","_postman_id":"5f65e052-b33d-4cfa-a7b4-97cdf26d773f","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","id":"c4f662f5-2518-439d-96d4-d0ab5450fe47","name":"Convrrt API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"26abb492-be20-4d3f-8a66-f15fa0cae583","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2493081f-24be-417c-9fa1-723109b0cce0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://production.builder.convrrt.com"}]}