FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Propagated callback doc. · agentfirstdev/whitelabel@38abbd2 · GitHub

Commit 38abbd2

Browse files
Propagated callback doc.
1 parent 34714e0 commit 38abbd2

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎search.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import Terms from '/snippets/whitelabel/search/terms.mdx';
1313
import Offset from '/snippets/whitelabel/search/offset.mdx';
1414
import Url from '/snippets/whitelabel/search/url.mdx';
1515
import Awaiting from '/snippets/whitelabel/search/awaiting.mdx';
16+
import Callback from '/snippets/whitelabel/search/callback.mdx';
1617

1718
<Reference endpoint='search' />
1819

@@ -53,6 +54,7 @@ The keys and values **{companyName}** supports are as follows:
5354
| `url` || The encoded URL of the results page to retrieve; if given, the URL overrides any of the above params |
5455
| `awaiting` || The lazy result features to wait to load, an `ai` overview, "People also ask" `answers`, or sponsored `ads`; any AI overview, which can take significant time to generate, is awaited for a maximum of **1 minute**; multiple features can be provided by repeating the key; lazy results aren't awaited by default |
5556
| `expiration` || The age in days of when to consider cached results expired, where `0` disables caching; `1` is the default number of days before expiration |
57+
| `callback` || The HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN to notify when the (prerequisite) asynchronous results have been retrieved |
5658

5759
### Response format
5860

@@ -67,3 +69,5 @@ feature infinite scrolling, the HTML of each page will be separated from the nex
6769
<Url />
6870

6971
<Awaiting />
72+
73+
<Callback />
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### Push notification
2+
3+
```shell
4+
curl -H "Authorization: Bearer ${{COMPANY_SLUG}}_TOKEN" \
5+
'https://{{API_ENDPOINT}}/search'\
6+
'?terms=amazon+simple+queue+service'\
7+
'&callback=https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
8+
```

0 commit comments

Comments
 (0)

Back | FazBrowse Home | New Git URL