Skip to main content
Qwilr API

API Reference

v1.0.0

Introduction

Welcome to the Qwilr Public API documentation. With our API you'll be able to generate Qwilr Pages programmatically. This means you can generate custom quotes, create pages when someone fills out a form, or anything else. The sky is the limit.

Our API is organized around REST. All calls made are live. If you need to test outside of your live account, get in touch with our team for options around that.

If you're looking for help with the Qwilr app you can find that in our help documentation.

If you have any questions about our API, please get in touch at help@qwilr.com.

Getting started?Check out our to walk through the process of getting set up
Base URL
https://api.qwilr.com/v1

Authentication

bearerAuth

All requests to API need to be authenticated with your account's API key. You can find your API key in the Qwilr API Settings:

Your API key allows anyone to access your Qwilr Pages and account. Be sure to keep it secret! Do not share your secret API keys in any public spaces such as your source repository, client-side code, and so forth.

When making a request:

  • Use your API key with bearer authentication in the headers. For example: Authorization: Bearer fakeapikey
  • Send all requests over HTTPS
Security Scheme Typehttp
HTTP Authorization Schemebearer
Bearer formatJWT
API settings page with a modal open to copy the API token

Projects

Project objects correspond to projects in the Qwilr UI, allowing for the creation of a public-facing Qwilr Page. The Foundry API allows you to create, delete and replace your Pages by sending through JSON objects.

Create a project

Creates a project from saved blocks or template.

Authorizations

bearerAuth

Attributes

  • templateIdRequiredstring(Id) ^[a-z0-9]{24}$
  • namestring
  • publishedboolean
  • substitutionsobject
  • metadataobject
  • tagsarray of strings

Responses

post/projects
{
"templateId": "6ee0f841f3cc8900090d82dc",
"name": "string",
"published": true,
"substitutions": {},
"metadata": {},
"tags": [
"string"
]
}

Update project

Currently only published property supported.

Authorizations

bearerAuth

Path parameters

  • projectIdRequiredstring(Id) ^[a-z0-9]{24}$

Attributes

  • publishedboolean

Responses

put/projects/{projectId}
{
"published": true
}

Blocks

Get saved blocks

Get saved blocks

Responses

get/blocks/saved

Subscriptions

Subscriptions allow you to subscribe and unsubscribe from events on your Qwilr account.

Create a webhook event subscription

Creates a new webhook subscription to an event type. New events will be sent to the defined targetUrl. You should store the id field returned in case you want to cancel the subscription later on.

Authorizations

bearerAuth

Attributes

  • eventRequiredenum
    "projectCreated""projectPublished""projectFirstViewed""projectViewed""projectAccepted""projectPreviewAccepted""commentThreadCreated""commentReplyCreated""commentMentionsCreated""commentThreadResolved"
  • targetUrlRequiredstring

Responses

post/webhooks
{
"event": "projectCreated",
"targetUrl": "string"
}

Cancel a webhook event subscription

Cancels a webhook event subscription using the id field that was returned when the webhook subscription was created.

Path parameters

  • subscriptionIdRequiredstring

    The id returned when your subscription was created

Responses

204

Unsubscribed

delete/webhooks/{subscriptionId}