Webhook

Update webhook

Update a webhook by its Id.

put/v2/webhooks/{webhook_id}

Request

Base URL
https://api.sandbox.eu.bandyer.com
URL
https://api.sandbox.eu.bandyer.com/v2/webhooks/{webhook_id}
Auth
API key in header apikey

Path parameters

webhook_idstring required

Webhook Id.

Request body

urlstring required

Webhook url.

version'0.1' | '1.0' | '2.0' required

should be version so "0.1" or "1.0" or "2.x" are allowed

Response

idstring

Webhook Id.

urlstring

Webhook url.

event'on_broadcast_new_feedback' | 'on_broadcast_pub_connected' | 'on_broadcast_pub_disconnected' | 'on_broadcast_recording_available' | 'on_broadcast_start' | 'on_broadcast_stop' | 'on_broadcast_sub_connected' | 'on_broadcast_sub_disconnected' | 'on_call_ended' | 'on_call_incoming' | 'on_message_sent' | 'on_missed_call' | 'on_recording_available' | 'on_recording_started' | 'on_recording_stopped' | 'on_room_created' | 'on_room_deleted' | 'on_room_disabled' | 'on_room_new_feedback' | 'on_session_ended' | 'on_session_paused' | 'on_session_resumed' | 'on_session_started' | 'on_upload_tag_added' | 'on_upload_tag_removed' | 'on_user_connected' | 'on_user_disconnected' | 'on_signature_enveloped_inserted' | 'on_transcription_available' | 'on_summarization_available'

Event name.

version'0.1' | '1.0' | '2.0'

should be version so "0.1" or "1.0" or "2.x" are allowed

activeboolean

Indicates if a webhook is active or not.

creation_datestring date-time

Creation date of a webhook.

Example response

{
  "creation_date": "2023-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.