webhook

Update a webhook

Changed on Jun 11, 2024

put/webhook/{id}

Request

Base URL
https://livepeer.studio/api
URL
https://livepeer.studio/api/webhook/{id}
Auth
HTTP bearer

Path parameters

idstring required

Request body

idstring

namestring required

kindstring

userIdstring

projectIdstring

The ID of the project

createdAtnumber

Timestamp (in milliseconds) at which stream object was created

eventsstring[]

urlstring uri required

sharedSecretstring

shared secret used to sign the webhook payload

streamIdstring

streamId of the stream on which the webhook is applied

Example request

{
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "name": "test_webhook",
  "kind": "webhook",
  "projectId": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
  "createdAt": 1587667174725,
  "events": [
    "stream.started",
    "stream.idle"
  ],
  "url": "https://my-service.com/webhook",
  "sharedSecret": "my-secret",
  "streamId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "status": {
    "lastFailure": {
      "timestamp": 1587667174725,
      "error": "Error message",
      "response": "Response body",
      "statusCode": 500
    },
    "lastTriggeredAt": 1587667174725
  }
}

Response

Success