Skip to content
view raw .md

Report channels

Discover chat channels available for `report_channels` when creating or configuring forms and check-ins. Channel IDs from this endpoint feed authoring payloads (max 3 per resource).

GET/v1/report-channels/API keyCLI Auth

List available report channels

Returns chat channels (Slack, Teams, Discord, Google Chat) available for report_channels on forms and check-ins. Use channel id values when creating or editing.

Query parameters

NameTypeRequiredDescription
namestringOptionalPrefix filter by channel name
limitintegerOptionalMax channels to return

Response

{
  "channels": "array",
  "total": "integer"
}

Errors

StatusWhen
401Missing or invalid credential
403Insufficient permissions (admin/manager required for write)
429Rate limited — Retry-After header set
curl -sS 'https://api.dailybot.com/v1/report-channels/?name=general' -H 'X-API-KEY: $DAILYBOT_API_KEY'

Try it

This is a copy-only helper — the request is not sent from your browser. Paste the command into your terminal to execute it.

  • CLI: dailybot channels list. Max 3 report channels per form/check-in.

Report channels

Discover chat channels available for report_channels when creating or configuring forms and check-ins. Channel IDs from this endpoint feed authoring payloads (max 3 per resource).

Authentication: X-API-KEY header or Authorization: Bearer <cli_token> with read capability.

Endpoints summary

Method Endpoint Description
GET /v1/report-channels/ List available report channels

GET /v1/report-channels/

Returns chat channels (Slack, Microsoft Teams, Discord, Google Chat) available for report_channels on forms and check-ins. Use channel id values when creating or editing.

Query parameters

Name Type Required Description
name string No Prefix filter by channel name.
limit integer No Maximum number of channels to return.
curl -sS 'https://api.dailybot.com/v1/report-channels/?name=general' \
  -H 'X-API-KEY: $DAILYBOT_API_KEY'

Response (200 OK):

{
  "channels": [
    {
      "id": "channel-uuid",
      "name": "general",
      "platform": "slack"
    }
  ],
  "total": 1
}

Response (401 Unauthorized): Missing or invalid credential.

Response (403 Forbidden): Insufficient permissions.

Response (429 Too Many Requests): Rate limited — Retry-After header is set.

CLI equivalent

dailybot channels list

Notes

  • Maximum 3 report channels per form or check-in.
  • Channel IDs must exist in this list when setting report_channels on create or config patch payloads.