Skip to content

Commit 83df1f7

Browse files
committed
Small extension of docs.
1 parent 533c168 commit 83df1f7

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/docs/how-to/firefly-iii/features/webhooks.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Webhooks need to be enabled before they work. Set `ALLOW_WEBHOOKS=true`, either
1212

1313
There are a bunch of triggers for webhooks in Firefly III:
1414

15-
- When a transaction is created, updated or removed
15+
- When a transaction is created, updated or removed.
1616
- When a budget is created, updated or removed
17-
- (some other trigger)
17+
- When a budget amount is set or changed
1818
- When any of the above happens
1919

2020
A webhook can respond to multiple triggers. BUT, you cannot combine the "After any event" with other triggers, it would have to be the only trigger. I hope this makes sense, because "After any event" already includes everything.
@@ -31,6 +31,12 @@ If you select "Relevant details" as the response, Firefly III will send the rele
3131

3232
It is mandatory to select "Relevant details" when you select "After any event" as the trigger. This is because "After any event" can trigger on many different events, and Firefly III cannot know what you want to receive. Therefore, it will always send the relevant details for the event that triggered the webhook.
3333

34+
Relevant details consist of:
35+
36+
- For transaction related events: the transaction itself
37+
- For budget related events: the budget itself
38+
- For budget amount related events: the "budget limit", i.e. the amount for that particular period.
39+
3440
### Transaction details
3541

3642
You can choose to receive the transaction details for transaction related events.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Firefly III supports webhooks, which you can read more about on the page about [
4848

4949
A webhook needs a title and a URL to work, and three important things.
5050

51-
1. A set of triggers. Use `GET api/v1/configuration/webhook.triggers` to get the available values. This may change in the future.
51+
1. A set of triggers. Use `GET api/v1/configuration/webhook.triggers` to get the available values, because they may change in the future.
5252
2. A response. Use `GET api/v1/configuration/webhook.responses` to see what is available. New responses may be added in the future.
5353
3. A delivery format. Use `GET api/v1/configuration/webhook.deliveries` to see what is available. This is only `JSON` right now.
5454

0 commit comments

Comments
 (0)