diff --git a/README.md b/README.md index 7a6716f..480c903 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,10 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref 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. +### Usage With Webhooks + +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. + ### Authentication 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) diff --git a/gen/templates/README.mustache b/gen/templates/README.mustache index ca1ee37..c59a851 100644 --- a/gen/templates/README.mustache +++ b/gen/templates/README.mustache @@ -80,6 +80,10 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref 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. +### Usage With Webhooks + +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. + ### Authentication 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)