Quill Developer Documentation

At Quill we believe that seamless integration with the tools and apps that teams use on a day-to-day basis is crucial for staying in flow and being productive.

While we have some ambitious ideas here, we recognize the importance of bringing along the apps and integrations you are already familiar with. To that extent, we have built out a Slack-compatible API as a starting point for integrations. We have extended that API and will continue to extend it in meaningful ways.

Interested in getting early access to our developer API? Please get in touch.

Get Started    

Reference

An incoming webhook allows you to generate a unique link at which you can post messages one-way into a channel. This is typically useful for testing and/or integrating Quill into other systems easily.

You can create an incoming channel webhook for a channel by going to Settings , selecting the Team that owns the channel, clicking the Incoming Webhooks tab then clicking Add Webhook .

Facts

Name

Value

URL

Copy this from the Incoming Webhooks tab in your team settings.

HTTP Method

POST

Accepted Content Types

application/json

OAuth Scope

N/A

Use Case

Post a new thread to the given channel. Posts a message to a thread if thread_ts is given or the channel is a direct message or group. You may also use thread_uid to post to a consistent thread.

Specification

Field

Description

Required

text

Text body to send. This field works differently whether you're using blocks or attachments.

Yes

attachments

A JSON-based array of structured attachments, presented as a URL-encoded string.

No

blocks

A JSON-based array of structured blocks, presented as a URL-encoded string.

No

thread_ts

Provide a thread_ts from a previous message's ts to thread the reply vs making a new thread in a channel.

No

thread_uid

A UID per webhook you can set that will map this to a thread id. The first time you use this, we'll insert a new thread. Subsequent requests with this set will post messages to the same thread. This is useful for integrating with systems where storing state is difficult (e.g. CI systems).

No

title

Set the title of a new thread, or update the title of an existing thread.

No

Example JSON body:

{
    "text": "hello world!"
}

For applications that don't support Incoming Webhooks, a service like https://webhook.site/ could be used to translate the payload into the right format.

Updated 2 months ago


Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.