v10

latestSwagger 2.02026-07-137784220.8 KB
Custom Speech web hooks:

Updates the web hook identified by the given ID.

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 challenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.

patch/webhooks/{id}

Path parameters

idstring uuid required

The identifier of the web hook.

Request body

webUrlstring uri

The registered URL that will be used to send the POST requests for the registered events to.

displayNamestring

The name of the object.

descriptionstring

The description of the object.

customPropertiesobject

The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.

Response

OK

webUrlstring uri required

The registered URL that will be used to send the POST requests for the registered events to.

selfstring uri

The location of this entity.

displayNamestring required

The display name of the object.

descriptionstring

The description of the object.

createdDateTimestring date-time

The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

lastActionDateTimestring date-time

The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed'

Describe the current state of the API

customPropertiesobject

The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.