Skip to content

Commit a7b7e10

Browse files
committed
docs: update and simplify webhook docs
1 parent f184724 commit a7b7e10

File tree

1 file changed

+9
-52
lines changed

1 file changed

+9
-52
lines changed

docs/webhook-config.md

Lines changed: 9 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ Different payloads can be configured for different events. Not all fields are ne
117117

118118
## Webhook Message types
119119

120-
### Entry
120+
### Entry / Entry fill
121121

122-
The fields in `webhook.entry` are filled when the bot executes a long/short. Parameters are filled using string.format.
122+
The fields in `webhook.entry` and `webhook.entry_fill` are filled when the bot places a long/short Order to increase a position, or when that order fills respectively. Parameters are filled using string.format.
123123
Possible parameters are:
124124

125125
* `trade_id`
@@ -162,31 +162,9 @@ Possible parameters are:
162162
* `current_rate`
163163
* `enter_tag`
164164

165-
### Entry fill
165+
### Exit / Exit fill
166166

167-
The fields in `webhook.entry_fill` are filled when the bot filled a long/short order. Parameters are filled using string.format.
168-
Possible parameters are:
169-
170-
* `trade_id`
171-
* `exchange`
172-
* `pair`
173-
* `direction`
174-
* `leverage`
175-
* `open_rate`
176-
* `amount`
177-
* `open_date`
178-
* `stake_amount`
179-
* `stake_currency`
180-
* `base_currency`
181-
* `quote_currency`
182-
* `fiat_currency`
183-
* `order_type`
184-
* `current_rate`
185-
* `enter_tag`
186-
187-
### Exit
188-
189-
The fields in `webhook.exit` are filled when the bot exits a trade. Parameters are filled using string.format.
167+
The fields in `webhook.exit` and `webhook.exit_fill` are filled when the bot places an exit order, or when that exit order fills respectively. Parameters are filled using string.format.
190168
Possible parameters are:
191169

192170
* `trade_id`
@@ -195,45 +173,24 @@ Possible parameters are:
195173
* `direction`
196174
* `leverage`
197175
* `gain`
198-
* `limit`
199176
* `amount`
200177
* `open_rate`
201-
* `profit_amount`
202-
* `profit_ratio`
203-
* `stake_currency`
204-
* `base_currency`
205-
* `quote_currency`
206-
* `fiat_currency`
207-
* `exit_reason`
208-
* `order_type`
209-
* `open_date`
210-
* `close_date`
211-
212-
### Exit fill
213-
214-
The fields in `webhook.exit_fill` are filled when the bot fills a exit order (closes a Trade). Parameters are filled using string.format.
215-
Possible parameters are:
216-
217-
* `trade_id`
218-
* `exchange`
219-
* `pair`
220-
* `direction`
221-
* `leverage`
222-
* `gain`
223178
* `close_rate`
224-
* `amount`
225-
* `open_rate`
226179
* `current_rate`
227180
* `profit_amount`
228181
* `profit_ratio`
229182
* `stake_currency`
230183
* `base_currency`
231184
* `quote_currency`
232185
* `fiat_currency`
186+
* `enter_tag`
233187
* `exit_reason`
234188
* `order_type`
235189
* `open_date`
236190
* `close_date`
191+
* `sub_trade`
192+
* `is_final_exit`
193+
237194

238195
### Exit cancel
239196

@@ -246,7 +203,7 @@ Possible parameters are:
246203
* `direction`
247204
* `leverage`
248205
* `gain`
249-
* `limit`
206+
* `order_rate`
250207
* `amount`
251208
* `open_rate`
252209
* `current_rate`

0 commit comments

Comments
 (0)