Skip to content

Commit 3dd8744

Browse files
authored
add note to README around usage with webhooks (#85)
* add note to README around usage with webhooks * wording update
1 parent 5c66b49 commit 3dd8744

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ Mux Python is a code generated lightweight wrapper around the Mux REST API and r
5454

5555
2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.
5656

57+
### Usage With Webhooks
58+
59+
At this moment, this SDK is not suitable for parsing or modeling webhook payloads, due to some incompatibilities in our API spec and our SDK generation tooling. We are working on resolving these issues, but for now you should only use this SDK for Mux's REST APIs.
60+
5761
### Authentication
5862
To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)
5963

gen/templates/README.mustache

+4
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ Mux Python is a code generated lightweight wrapper around the Mux REST API and r
5454

5555
2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.
5656

57+
### Usage With Webhooks
58+
59+
At this moment, this SDK is not suitable for parsing or modeling webhook payloads, due to some incompatibilities in our API spec and our SDK generation tooling. We are working on resolving these issues, but for now you should only use this SDK for Mux's REST APIs.
60+
5761
### Authentication
5862
To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)
5963

0 commit comments

Comments
 (0)