API Methods

An introduction to the methods supported in our public API. Enterprise API plans with custom integrations may have access to endpoints that are not defined in our public documentation.
DailyBot's API is versioned, the endpoint paths shown in this reference are omitting the base URL and the version. See the Authentication section to understand about headers and versioning.

As example, a proper URL to call the API is: https://api.dailybot.com/v1/me/

Get contextual info

GET /me/

Returns a JSON object with the organization name and UUID.

Query string params:
  • None
Response example
{
   "user": "Tony Stark",
   "organization_uuid": "b1b292b3-29b2-4235-8103-321ed749db8d",
   "organization_name": "Stark Industries"
}

Listing the check-ins

GET /followups/

Returns a JSON list of objects, with all the check-ins that are visible for the user (API key owner).

Query string params:
  • None
Response example
[
{
  "id": "b1b292b3-29b2-4235-8103-321ed749db8d",
  "name": "Team standups",
  "active": true,
  "is_anonymous": true,
  "privacy": "managers_and_members",
  "frequency_type": "weekly",
  "frequency": 1,
  "frequency_on_days": [
    1,
    2,
    3,
    4,
    5
  ],
  "custom_trigger_time": null,
  "send_reports_one_by_one": true,
  "time_for_report": null,
  "start_on": "2021-01-27",
  "end_on": null
},
...
]

Listing check-in responses

GET /followups/{followup-uuid}/responses/

Returns a JSON object with the all responses for the given follow-up.

Query string params:
  • date_start (optional): YYYY-MM-DD format to set a start date of the query, current date is the default value of this parameter
  • date_end (optional): YYYY-MM-DD format to set an end date of the query, current date is the default value of this parameter
  • limit (optional): sets max limit of responses per page
  • offset (optional): sets the cursor position for the beginning of results
Response example
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
      {
          "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "user": {
              "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
              "full_name": "Anonymous Swan",
              "image": "https://some-url.com",
              "username": "anonymous",
              "occupation": "Team Member",
              "anonymous": true
          },
          "is_anonymous": true,
          "responses": [
              {
                  "question": "What did you complete yesterday?",
                  "question_short": "Yesterday's progress",
                  "question_type": "text",
                  "response": "response 1",
                  "is_blocker": false
              },
              {
                  "question": "What are you planning to work on today?",
                  "question_short": "Plans for today",
                  "question_type": "text",
                  "response": "response 2",
                  "is_blocker": false
              },
              {
                  "question": "Great. Do you have any blockers?",
                  "question_short": "Any blockers?",
                  "question_type": "text",
                  "response": "no",
                  "is_blocker": true
              }
          ],
          "response_completed": true,
          "has_issue": false,
          "created_at": "2020-12-22T23:34:33.235720Z",
          "updated_at": "2020-12-22T23:34:33.252585Z"
      },
...
  ]
}

Managing WebHooks

POST /webhook-subscription/

Creates a web hook subscription.

Request payload
{
   "hook_url": "https://your-hook-endpoint.com/path/",
   "subscribed_objects": [string(FollowupUUID),...],
   "subscriptions": [string(EventSubscribed),...],
   "immediate_sample_event:" boolean
}

The EventSubscribed is a string defining a type of event, see the type of events.
If immediate_sample_event is set as true, DailyBot will send a sample payload to that URL immediately upon the creation of this outgoing webhook.

Response example
{
   "id": string(HookUUID),
   "url": string(HookURL)
}

DELETE /webhook-subscription/{HookUUID}/

Deletes a web hook subscription, responds with HTTP 200 status when successful.

Need support?
Contact us