@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Add an explicit example of constraining "transaction.search" to the webhook documentation
Summary:
Depends on D19509. Ref T13151. See PHI725. `transaction.search` supports "constraints" and the documentation mentions it in passing, but doesn't really show how to do it, and the method is not automatically self-documenting because it isn't a "real" `*.search` method.
Add an example of how to use the `contraints` parameter to retrieve information about only the relevant transactions.
Also remove a refernece to `requestb.in`, which is now defunct.
Test Plan: Called `transaction.search` with similar parameters.
Reviewers: amckinley
Reviewed By: amckinley
Maniphest Tasks: T13151
Differential Revision: https://secure.phabricator.com/D19510
+14
-3
+14
-3
src/docs/user/userguide/webhooks.diviner
+14
-3
src/docs/user/userguide/webhooks.diviner
···
38
38
phabricator/ $ ./bin/webhook call --id 42 --object D123
39
39
```
40
40
41
-
You can use a tool like [[ https://requestb.in | RequestBin ]] to inspect
42
-
the headers and payload for calls to hooks.
43
-
44
41
45
42
Verifying Requests
46
43
==================
···
156
153
Hooks that are interested in changes should generally make a call to
157
154
`transaction.search`, passing the transaction PHIDs as a constraint to retrieve
158
155
details about the transactions.
156
+
157
+
For example, your call to `transaction.search` may look something like this:
158
+
159
+
```lang=json
160
+
{
161
+
"objectIdentifier": "PHID-XXXX-abcdef",
162
+
"constraints": {
163
+
"phids": [
164
+
"PHID-XACT-XXXX-11111111",
165
+
"PHID-XACT-XXXX-22222222"
166
+
]
167
+
}
168
+
}
169
+
```
159
170
160
171
The `phid.query` method can also be used to retrieve generic information about
161
172
a list of objects.