Hooks

Fetch All webhooks

Fetches all company webhooks endpoints.

Base url https://api.omegastream.net/company this will be called from now as [base_url]

Endpoint

GET: [base_url]/client/webhooks/all

Headers

Key Value Details
Authorization Bearer {{api_key}} api key is very important here to authorize your request.
Content-Type application/json

Response

[
    {
        "id": "631c652c15fa642045c1a003",
        "created_at": "2022-09-10T10:21:32.192Z",
        "updated_at": "2022-09-10T10:21:32.192Z",
        "coid": "omega-cop-KoNef9DB5i",
        "url": "http://localhost:6060/webhook",
        "description": null,
        "events": [
            "video.uploaded",
            "video.ready_for_processing",
            "video.in_progress",
            "video.completed_processing",
            "video.process_failed",
            "video.process_succeeded",
            "video.ready_to_watch"
        ],
        "active": true
    }
]

To learn more about the available events and how to use theme, checkout Create Endpoint.


Update webhook endpoint

Endpoint

PUT: [base_url]/company/webhooks/:id
  • :id is the endpoint id value.

Delete webhook endpoint

Delete a specific webhook, thus not sending any future event to it.

Endpoint

DELETE: [base_url]/company/webhooks/:id
  • :id is the endpoint id value.

Headers

Key Value Details
Authorization Bearer {{api_key}} api key is very important here to authorize your request.
Content-Type application/json

Response

Response code: OK 200

{
    "message": "webhook endpoint deleted"
}

Update status

You simply activate or deactivate your endpoint.

Endpoint

POST: [base_url]/company/webhooks/:id/status
  • :id is the endpoint id value.

Headers

Key Value Details
Authorization Bearer {{api_key}} api key is very important here to authorize your request.
Content-Type application/json

Request body

{
    "active": true
}
  • active: true the endpoint will be active and can receive its events.
  • active: false the endpoint will be completely has no effect.