WebhookApi.md

WebhookApi

All URIs are relative to http://localhost/api

Method	Description	HTTP request
create()	Create webhook	POST /webhooks
get()	Get user's webhook by id	GET /webhooks/{id}
update()	Update event webhook	PATCH /webhooks/{id}
delete()	Delete webhook	DELETE /webhooks/{id}
list()	Get list webhooks	GET /webhooks
check()	Check webhook by id	POST /webhooks/check/{id}

create() - Create webhook

Webhooks can push notifications to your server, rather than polling streaming service for changes

Parameters

Name	Type	Required	Description
request	CreateWebhookRequest	yes	Create Webhook input

Return type

Promise<CreateWebhookResponse>.

---

get() - Get user's webhook by id

Retrieve webhook details by id.

Parameters

Name	Type	Required	Description
id	string	yes	webhook's id

Return type

Promise<GetUserWebhookResponse>.

---

update() - Update event webhook

This endpoint will update the indicated webhook.

Parameters

Name	Type	Required	Description
id	string	yes	webhook's id
request	UpdateWebhookRequest	yes	Update Webhook input, events example: video.encoding.quality.completed

Return type

Promise<ResponseSuccess>.

---

delete() - Delete webhook

This endpoint will delete the indicated webhook.

Parameters

Name	Type	Required	Description
id	string	yes	Webhook ID

Return type

Promise<ResponseSuccess>.

---

list() - Get list webhooks

This method returns a list of your webhooks (with all their details).

You can filter what the webhook list that the API returns using the parameters described below.

Parameters

Name	Type	Required	Description
search	string	no	only support search by name
sortBy	'created_at' | 'name'	no	sort by
orderBy	'asc' | 'desc'	no	allowed: asc, desc. Default: asc
offset	number	no	offset, allowed values greater than or equal to 0. Default(0)
limit	number	no	results per page. Allowed values 1-100, default is 25
encodingFinished	boolean	no	search by event encoding finished
encodingStarted	boolean	no	search by event encoding started
fileReceived	boolean	no	search by event file received

Return type

Promise<GetWebhooksListResponse>.

---

check() - Check webhook by id

This endpoint will check the indicated webhook.

Parameters

Name	Type	Required	Description
id	string	yes	webhook's id

Return type

Promise<ResponseSuccess>.

---