Skip to main content
POST
/
webhooks
Python
import requests

response = requests.post(
    "https://api.roe-ai.com/webhooks/",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "name": "Job Notifications",
        "url": "https://your-server.com/webhooks/roe",
        "events": ["job_completed"]
    }
)
webhook = response.json()
print(f"Created webhook: {webhook['id']}")
{
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "headers": {},
  "events": [
    "<string>"
  ],
  "is_active": true,
  "alerts": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
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.

Body

Serializer for creating webhooks

name
string
required

User-friendly name for this webhook

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

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

201 - application/json

Webhook created successfully

Serializer for creating webhooks

name
string
required

User-friendly name for this webhook

Maximum string length: 255
url
string<uri>
required

Webhook endpoint URL

Maximum string length: 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'])

is_active
boolean
alerts
string<uuid>[]