Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Accept: "application/json"
X-Api-Key: <your-api-key>

Supported Endpoints

List a team’s experiments

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#EAE6FF

This endpoint is paginated. The response body will include links to the next and previous pages

...

Code Block
languagejson
{
  "results": ["name": "experiment 1", "experiment_id": "1cc121f1-e69f-4340-9fef-91daf735f6bc"],
  "next": "<url to the next page>",
  "previous": "<url to the previous page>"
}

Send a message to the bot

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#EAE6FF

Your client needs to wait for the bot response in this call. There is currently no way to ask for it in the future

...

Code Block
languagejson
{
  "response": "the bot's response"
}

Add or Update participant data

URL: https://chatbots.dimagi.com/channels/api/participants/<participant-id>

...

Code Block
languagejson
{
  "participant-1-id": {"name": "John", "surname": "Doe"},
  "participant-2-id": {"name": "Jane", "surname": "Doe"},
}

Response body:

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#EAE6FF

If there are errors, the errors key will be present in the response body, otherwise it will be empty

...