You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.1.0.md
+24-6
Original file line number
Diff line number
Diff line change
@@ -1845,6 +1845,8 @@ A map of possible out-of band callbacks related to the parent operation.
1845
1845
Each value in the map is a [Path Item Object](#pathItemObject) that describes a set of requests that may be initiated by the API provider and the expected responses.
1846
1846
The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
1847
1847
1848
+
To describe incoming requests from the API provider independent from another API call, use the [`webhooks`](#oasWebhooks) field.
The following example shows a callback to the URL specified by the `id` and `email` property in the request body.
1901
+
The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook.
description: webhook successfully processed and no retries will be performed
1915
+
description: callback successfully processed
1914
1916
```
1915
1917
1918
+
The following example shows a callback where the server is hard-coded, but the query string parameters are populated from the `id` and `email` property in the request body.
0 commit comments