This is the API for developers to extend Doorbell. You can interact with Doorbell's data (applications, organizations, existing feedback thread, etc).
Looking to send feedback from your own form? That's the Feedback Capture API, which uses your application's ID and key instead of an access token. The Data API is for working with the feedback that's already in Doorbell.
The base URL for the API is: https://doorbell.io/api
Each access token is granted one or more scopes. Endpoints that only read data require the read scope, while endpoints that create, update, or delete data require the write scope. The required scope is shown next to each endpoint below.
The Data API is available on the Enterprise plan. You can use it if any application or organization you belong to has an active Enterprise plan.
Access tokens are created in your account settings, which only show the API access section once you're on an eligible plan. Requests made with an access token after the Enterprise plan ends are rejected with a 403 response.
To upgrade, or to ask about API access for your team, email hello@doorbell.io.
Send the JSON boolean true to archive the thread, or false to unarchive it
true
Responses
HTTP Code
Content Type
Response Body
200
application/json
{
"data": {
"id": 12,
"email": "member@example.com",
"gravatar": "https:\/\/secure.gravatar.com\/avatar\/a4fae232e2bfebd9f4dc8d7cb6caecb2?s=64&d=mm",
"message": "My feedback is that I am very happy with the service",
"permalink": "https:\/\/doorbell.io\/applications\/1\/feedback\/12",
"sentiment": "positive",
"member": {
"id": 23,
"email": "member@example.com",
"name": "George Customer",
"created_at": 1790580709,
"updated_at": 1793547150
},
"attachments": [],
"is_anonymous": false,
"can_reply": true,
"archived": false,
"first_reply_time": null,
"last_reply_time": 1793547150,
"ip_address": "216.73.216.163",
"user_agent": "Mozilla\/5.0 AppleWebKit\/537.36 (KHTML, like Gecko; compatible; ClaudeBot\/1.0; +claudebot@anthropic.com)",
"properties": [],
"created_at": 1793547150,
"updated_at": 1793547150,
"replies": []
}
}
400
text/plain
Nothing sent to update
404
text/plain
Invalid application
404
text/plain
Invalid feedback
500
text/plain
Could not update feedback
POST/applications/{id}/feedback/{feedback_id}/repliesscope: writeLink to this section
Send a reply to a feedback thread
Request Parameters
Name
Description
Example
id
ID of an application
1
feedback_id
ID of a feedback thread
12
Request Body
Content-Type: application/json
Name
Required
Description
Example
message
The reply message to send as the authenticated user
Thanks for the feedback!
type
The type of reply to create. Use reply (the default) for a public reply visible to the customer, or note for an internal note visible only to your agents. Internal notes require a plan that includes them.
note
Responses
HTTP Code
Content Type
Response Body
200
application/json
{
"data": {
"id": 12,
"email": "member@example.com",
"gravatar": "https:\/\/secure.gravatar.com\/avatar\/a4fae232e2bfebd9f4dc8d7cb6caecb2?s=64&d=mm",
"message": "My feedback is that I am very happy with the service",
"permalink": "https:\/\/doorbell.io\/applications\/1\/feedback\/12",
"sentiment": "positive",
"member": {
"id": 23,
"email": "member@example.com",
"name": "George Customer",
"created_at": 1790580709,
"updated_at": 1793547150
},
"attachments": [],
"is_anonymous": false,
"can_reply": true,
"archived": false,
"first_reply_time": null,
"last_reply_time": 1793547150,
"ip_address": "216.73.216.163",
"user_agent": "Mozilla\/5.0 AppleWebKit\/537.36 (KHTML, like Gecko; compatible; ClaudeBot\/1.0; +claudebot@anthropic.com)",
"properties": [],
"created_at": 1793547150,
"updated_at": 1793547150,
"replies": []
}
}
