Feedback Capture API documentation

Basics

This is the API for capturing user feedback and saving it in Doorbell (if you're planning on writing your own widget).

The base URL for the API is: https://doorbell.io/api

All requests should be POST requests.

Please provide a useful User-Agent header with each request!

Authentication

Doorbell has an application ID and a secret key that need to be used when making API calls. The ID constructs part of the URL in each call (/applications/{id}/{action}), and the key should always be passed as a query string parameter, using the name key. (e.g. https://doorbell.io/api/applications/1/open?key=key-goes-here)

To obtain an application ID/key, you need to register here on Doorbell, create an application, go to the setup page, and copy the ID/Key from the API tab.

Endpoints

Open

Request sent when the form is displayed to the user.

Endpoint: /applications/{id}/open

GET Parameters:

  • key - application key

Responses

  • 201: OK
  • 403: Invalid key
  • 404: Unknown application

Submit

Request sent when the form is submitted.

Endpoint: /applications/{id}/submit

GET Parameters:

  • key - application key

POST Parameters (required):

  • email - a valid email address, the address of the user sending feedback
  • message - the feedback message the user has entered

POST Parameters (optional):

  • name - the name of the user who is sending feedback
  • properties - JSON encoded string or properties (of any data type)
  • attachments - Array of attachment IDs (get these from uploading to the upload endpoint

Responses

  • 201: Saved
  • 400: Your message is required
  • 400: Your email address is required
  • 400: Invalid email address
  • 403: Invalid key
  • 404: Unknown application

Upload

Request sent when uploading an attachment (for the subsequent submit request).

The endpoint (on success) will return a JSON array of IDs. These IDs need to be supplied to the submit request afterwards.

Endpoint: /applications/{id}/upload

GET Parameters:

  • key - application key

POST Parameters (required):

  • Multipart form request, including any number of files

Responses

  • 201: Saved
  • 400: Uploads not enabled
  • 400: No files found (could mean an error in how the files are sent)
  • 403: Invalid key
  • 404: Unknown application