Skip to main content
PATCH
/
webhooks
/
{webhook_id}
Python
import requests

webhook_id = "your-webhook-id"
response = requests.patch(
    f"https://api.roe-ai.com/webhooks/{webhook_id}/",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={"name": "Updated Webhook Name"}
)
webhook = response.json()
print(f"Updated: {webhook['name']}")
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "alerts": [
    "<string>"
  ],
  "failure_count": 123,
  "created_by": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "headers": {},
  "events": [
    "<string>"
  ],
  "is_active": true,
  "last_triggered_at": "2023-11-07T05:31:56Z",
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z"
}
This API endpoint will be available in the next release. For now, use the Roe UI to manage webhooks.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
webhook_id
string<uuid>
required

Body

Serializer for updating webhooks

​
name
string

User-friendly name for this webhook

Required string length: 1 - 255
​
url
string<uri>

Webhook endpoint URL

Required string length: 1 - 500
​
secret
string
Maximum string length: 255
​
headers
object

Custom headers to include in webhook requests (key-value pairs)

​
events
string[]

List of events to trigger this webhook (e.g., ['triggered'])

Minimum string length: 1
​
is_active
boolean
​
alerts
string<uuid>[]

Response

200 - application/json

Updated webhook

Serializer for Webhook model

​
id
string<uuid>
required
​
name
string
required

User-friendly name for this webhook

Maximum string length: 255
​
url
string<uri>
required

Webhook endpoint URL

Maximum string length: 500
​
alerts
string[]
required

Alert IDs

​
failure_count
integer
required

Number of consecutive failures

​
created_by
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
secret
string
Maximum string length: 255
​
headers
object

Custom headers to include in webhook requests (key-value pairs)

​
events
string[]

List of events to trigger this webhook (e.g., ['triggered'])

​
is_active
boolean
​
last_triggered_at
string<date-time>
​
last_success_at
string<date-time>
​
last_failure_at
string<date-time>