Working with webhooks from Ruby SDK
Ruby SDK offers you a way to work with webhooks through the API.
Webhooks are great to know what is happening by simply listening on your server for things to happen. See bellow how you can use our API in regards to webhooks.
Ruby SDK Webooks Methods
- create Create a new webhook for the given url to catch the given events.
ziggeo.webhooks().create(arguments = nil)
- target_url The url that will catch the events
- encoding Data encoding to be used by the webhook to send the events.
- events Comma-separated list of the events the webhook will catch. They must be valid webhook type events.
This method returns stringExample:=begin This script shows you how to create a webhook, which you'll later need to confirm. Parameters you need to pass: 1. APP_TOKEN 2. PRIVATE_KEY 3. SERVER_URL 4. EVENTS Example call: ruby webhooks_create.rb APP_TOKEN PRIVATE_KEY SERVER_URL video_create ruby webhooks_create.rb APP_TOKEN PRIVATE_KEY SERVER_URL video_create video_delete video_failed =end require_relative "../lib/Ziggeo" app_token = ARGV[0]; private_key = ARGV[1]; server_url = ARGV[2]; events_to_catch = ARGV[3]; ziggeo = Ziggeo.new(app_token, private_key) webhook_id = ziggeo.webhooks.create( target_url: server_url, events: events_to_catch ) puts webhook_id
- confirm Confirm a webhook using its ID and the corresponding validation code.
ziggeo.webhooks().confirm(arguments = nil)
- webhook_id Webhook ID that's returned in the creation call.
- validation_code Validation code that is sent to the webhook when created.
This method returns stringExample:=begin This script shows you how to confirm a webhook to start catching events. Parameters you need to pass: 1. APP_TOKEN 2. PRIVATE_KEY 3. WEBHOOK_ID 4. VALIDATION_CODE Example call: ruby webhooks_confirm.rb APP_TOKEN PRIVATE_KEY WEBHOOK_ID VALIDATION_CODE =end require_relative "../lib/Ziggeo" app_token = ARGV[0]; private_key = ARGV[1]; webhook_id = ARGV[2]; validation_code = ARGV[3]; ziggeo = Ziggeo.new(app_token, private_key) response = ziggeo.webhooks.confirm( webhook_id: webhook_id, validation_code: validation_code ) puts response
- delete Delete a webhook using its URL.
ziggeo.webhooks().delete(arguments = nil)
- target_url The url that will catch the events
This method returns stringExample:=begin This script shows you how to delete a webhook. Parameters you need to pass: 1. APP_TOKEN 2. PRIVATE_KEY 3. WEBHOOK_URL Example call: ruby webhooks_delete.rb APP_TOKEN PRIVATE_KEY WEBHOOK_URL =end require_relative "../lib/Ziggeo" app_token = ARGV[0]; private_key = ARGV[1]; server_url = ARGV[2]; ziggeo = Ziggeo.new(app_token, private_key) response = ziggeo.webhooks.delete( target_url: server_url ) puts response == "null" ? "Webhook deleted." : response