Skip to content

Commit 81b3092

Browse files
authored
Merge pull request #230 from intercom/readme_rate_limit
Adding readme updates for rate limit PR
2 parents e7dd6d1 + fb126be commit 81b3092

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,15 @@ $client->notes->getNotes([
332332
// Get a single Note by id
333333
$client->notes->getNote("42");
334334
```
335+
## Rate Limits
336+
Rate limit info is passed via the rate limit headers.
337+
You can access this information as follows:
338+
```
339+
$rate_limit = $intercom->getRateLimitDetails();
340+
print("{$rate_limit['remaining']} {$rate_limit['limit']} \n");
341+
print_r($rate_limit['reset_at']->format(DateTime::ISO8601));
342+
```
343+
For more info on rate limits and these headers please see the [API ref docs](https://developers.intercom.com/reference#rate-limiting)
335344

336345
## Pagination
337346

0 commit comments

Comments
 (0)