logo

Webhooks usage

webhooks

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:

Text 
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:

Text 
https://boomstream.com/api/webhook/info?apikey={{API_KEY}}&code=webhook_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:

Text 
https://boomstream.com/api/webhook/update?apikey={{API_KEY}}&code=webhook_code&event=webhook_type&url=link_to_listener&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:

Text 
https://boomstream.com/api/webhook/create?apikey={{API_KEY}}&event=webhook_type&url=link_to_listener&format=json

delete

Remove the webhook

Input parameters:

Required parameters:

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

Example request:

Text 
https://boomstream.com/api/webhook/delete?apikey={{API_KEY}}&code=webhook_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:

Text 
https://boomstream.com/api/webhook/events?apikey={{API_KEY}}&format=json