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    

Shortcuts

Shortcuts give Quill users a clear entry point to access your integration.

Message Shortcuts

Quill supports message shortcuts, which allow the user to select a message or range of messages, and have Quill ping your integration with the contents of those messages.

An example use case would be selecting a range of messages in a conversation, and appending them as comments to a new or existing GitHub issue.

Once the shortcut is initiated, Quill will POST a request to the request_url your integration registered with.

Specification

FieldDescription
typeEither shortcut or message_action. Helps identify which type of interactive component sent the payload. Global shortcuts will return shortcut, message shortcuts will return message_action.
callback_idAn ID that you defined when creating the shortcut.
trigger_idA temporary ID generated for the interaction in your app. This value can be used to open modal .
response_urlA temporary webhook that can be used to send messages in response to interactions. This field will only be included for message shortcuts.
userThe user who initiated the shortcut.
messageThe message that the user initiated the shortcut from. This field will only be included for message shortcuts. This will include the full structure of the message.
messagesA list of messages that the user initiated the shortcut from. This field will only be included for message shortcuts. This will include the full structure of each message. In the event that this list contains multiple messages, the above message property will contain the first message.
channelThe channel that the source message was located in. This field will only be included for message shortcuts.
teamThe team that the shortcut was initiated in.
tokenThe access_token you received when installing your application with Quill.

Example payload:

{
  "token": "Nj2rfC2hU8mAfgaJLemZgO7H",
  "callback_id": "chirp_message",
  "type": "message_action",
  "trigger_id": "13345224609.8534564800.6f8ab1f53e13d0cd15f96106292d5536",
  "response_url": "https://api.quill.chat/webhooks/commands/T0MJR11A4/21974584944/yk1S9ndf35Q1flupVG5JbpM6",
  "team": {
    "id": "T0MJRM1A7",
    "domain": "pandamonium",
  },
  "channel": {
    "id": "D0LFFBKLZ",
    "name": "cats"
  },
  "user": {
    "id": "U0D15K92L",
    "name": "dr_maomao"
  },
  "message": {
    "type": "message",
    "user": "U0MJRG1AL",
    "ts": "1516229207.000133",
    "text": "World's smallest big cat! <https://youtube.com/watch?v=W86cTIoMv2U>"
  },
  "messages": [{
    "type": "message",
    "user": "U0MJRG1AL",
    "ts": "1516229207.000133",
    "text": "World's smallest big cat! <https://youtube.com/watch?v=W86cTIoMv2U>"
  }]
}

As with other interaction payloads, you can send a response directly in reply to the POST request, or respond using the attached response_url or trigger_id to trigger a modal (see here ).

Global Shortcuts (Coming soon)

Quill plans on supporting global shortcuts, which allow the user an entrypoint into your app without needing to invoke it via a slash command or a message shortcut. Instead, global shortcuts are available in a global context. Let us know if you want to use this feature for your integration, and we can expedite development.

Updated 2 months ago


Shortcuts


Suggested Edits are limited on API Reference Pages

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