Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update documentation on create-kobo-headers after method of logging in to Kobo was updated
  • Loading branch information
smeber authored Dec 9, 2024
1 parent 72f8a90 commit 4f895ee
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ See below for an example configuration, in which programId was not included as a
## Create headers endpoint
If you need to map a lot of questions, creating the headers manually is cumbersome. The `/create-kobo-headers` endpoint automates this. It expects 4 query parameters:
- `system`: required, enum (options: 121, espocrm, generic)
- `kobouser`: your Kobo username
- `kobopassword`: your Kobo password
- `koboassetId `: the assed id of the survey (to be found in the url: https://kobonew.ifrc.org/#/forms/`ASSETID`/summary)
- `koboassetId`: the asset id of the survey (to be found in the url: https://kobonew.ifrc.org/#/forms/`ASSETID`/summary)
- `kobotoken`: the kobo token of the account the survey is available at (Click on 'account' icon top right > Account Settings > Security > API Key shown is the kobotoken)
- `hookId `:

In the body you can pass all the headers you want to create as key value pairs, for example:
```json
Expand All @@ -142,6 +142,8 @@ In the body you can pass all the headers you want to create as key value pairs,
}
```

Tip: When you have the headers (/mapping) for example in an Excel table, you can copy that into ChatGPT and ask it to transform the table to key value pairs. It might save time setting up the body needed.

This endpoint assumes the IFRC Kobo server (`https://kobonew.ifrc.org`)

## Generic endpoint
Expand Down

0 comments on commit 4f895ee

Please sign in to comment.