Skip to content

Commit e1fd5bb

Browse files
authored
Update index.md
Signed-off-by: James Cole <james@firefly-iii.org>
1 parent 28b3081 commit e1fd5bb

File tree

1 file changed

+5
-1
lines changed
  • docs/docs/references/firefly-iii/api

1 file changed

+5
-1
lines changed

docs/docs/references/firefly-iii/api/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Please visit the [dedicated Swagger documentation](https://api-docs.firefly-iii.
1010

1111
The API is slated to become the only way to talk to Firefly III: even the UI would use the API exclusively. Alas, this is a work in progress.
1212

13+
## Developing with the Firefly III API
14+
15+
If you want to keep up with changes to the Firefly III API, be sure to sign up to [the Firefly III dev mailing list](https://firefly-iii.kit.com/dev). It's free and low-frequency.
16+
1317
## Currencies in the API
1418

1519
All objects where currency is relevant have `currency_*` attributes. They refer to the currency set in the object. Most objects (accounts, transactions, etc.) carry their own currency settings. For example, a bill or a piggy bank has its own currency, regardless of the primary currency of the administration. Expect something like this:
@@ -52,4 +56,4 @@ When you create a webhook you can choose webhook-specific data to be the respons
5256

5357
However, when you create a webhook that ALSO triggers on the creation of a new budget, you cannot set the transaction details as the expected response. In that case, you must select the option "The relevant details" (`RELEVANT`) which will automatically select the correct data to send as response.
5458

55-
The reason this is complicated is because some webhook triggers come with multiple possible responses, so it is always up to you to select what you need. However, for some trigger combinations `RELEVANT` is the only possible response.
59+
The reason this is complicated is because some webhook triggers come with multiple possible responses, so it is always up to you to select what you need. However, for some trigger combinations `RELEVANT` is the only possible response.

0 commit comments

Comments
 (0)