Webhooks usage

Methods: list | info | update | create | delete | events

list

List of webhooks in the project

Input parameters:

• String apikey (API key)

Output parameters

• Array list (List of webhooks)

Example request:

https://boomstream.com/api/webhook/list?apikey=[API_KEY]&format=json

info

Webhook information

Input parameters:

Required parameters:

• String apikey (API key)
• String code (Webhook code)

Output parameters

• String code (Webhook code)
• String event (Webhook type)
• String url (Reference to your webhook listener)

Example request:

https://boomstream.com/api/webhook/info?apikey=[API_KEY]&code=[CODE]&format=json

update

Update webhook

Input parameters:

Required parameters:

• String apikey (API key)
• String code (Webhook code)

Optional parameters:

• String event (Webhook type)
• String url (Reference to your webhook listener)

Example request:

https://boomstream.com/api/webhook/update?apikey=[API_KEY]&code=[CODE]&event=[EVENT]&url=[URL]&format=json

create

Create webhook

Input parameters:

Required parameters:

• String apikey (API key)
• String event (Webhook type)
• String url (Reference to your webhook listener)

Output parameters

• String code (Created webhook code)

Example request:

https://boomstream.com/api/webhook/create?apikey=[API_KEY]&event=[EVENT]&url=[URL]&format=json

delete

Remove the webhook

Input parameters:

Required parameters:

• String apikey (API key)
• String code (Webhook code)

Example request:

https://boomstream.com/api/webhook/delete?apikey=[API_KEY]&code=[CODE]&format=json

events

List of available webhook types

Input parameters:

• String apikey (API key)

Output parameters

• Array events (List of available events)

Example request:

https://boomstream.com/api/webhook/events?apikey=[API_KEY]&format=json