{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Custom Speech Web Hooks: API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Custom Speech Web Hooks:", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets The List Of Web Hooks For The Authenticated Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webhooks", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of datasets that will be skipped." }, { "name": "top", "value": "", "type": "query", "description": "Number of datasets that will be included after skipping." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Creates A New Web Hook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks" }, "docs": "If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with
the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.

When calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event
types. There will be one request per registe" }, { "info": { "name": "Microsoft Azure Gets The Web Hook Identified By The Given Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Updates The Web Hook Identified By The Given Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook." } ] }, "docs": "If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature
headers. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash
will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.

If the URL changes, the web hook will stop receiving events until a
cha" }, { "info": { "name": "Microsoft Azure Deletes The Web Hook Identified By The Given Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/webhooks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Sends A Ping Event To The Registered Url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/:id/ping", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook to ping." } ] }, "docs": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.
The Swagger Schema ID of the model is WebHookV3.

The request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with
a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with
the secret as HMAC key. The hash is base64 encoded." }, { "info": { "name": "Microsoft Azure Sends A Request For Each Registered Event Type To The Registered Url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/:id/test", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook to ping." } ] }, "docs": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,
the POST will respond with 204. If a test request can be made, it will respond with 200.
The request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.
If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload" }, { "info": { "name": "Microsoft Azure Sends A Ping Event To The Registered Url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/:id:ping", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook to ping." } ] }, "docs": "The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook.
The Swagger Schema ID of the model is WebHookV3.

The request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with
a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with
the secret as HMAC key. The hash is base64 encoded." }, { "info": { "name": "Microsoft Azure Sends A Request For Each Registered Event Type To The Registered Url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/:id:test", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the web hook to ping." } ] }, "docs": "The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types,
the POST will respond with 204. If a test request can be made, it will respond with 200.
The request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type.
If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload" } ] } ], "bundled": true }