创建 Webhook - Open Managed Agents

POST

/

v1

/

webhooks

创建 Webhook

curl --request POST \
  --url http://localhost:38080/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "enabled_events": []
}
'

import requests

url = "http://localhost:38080/v1/webhooks"

payload = {
    "url": "<string>",
    "name": "<string>",
    "enabled_events": []
}
headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'anthropic-beta': '<anthropic-beta>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', name: '<string>', enabled_events: []})
};

fetch('http://localhost:38080/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"enabled_events\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "wh_01H...",
  "type": "webhook",
  "url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "enabled_events": [
    "session.status_run_started"
  ],
  "status": "enabled",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "disabled_reason": "<string>"
}

每个请求都必须发送 anthropic-beta: webhooks-2026-03-01。创建接口只返回一次签名密钥。

授权

X-Api-Key

string

header

默认值:sk-ant-local-default

必填

OMA 工作区 API 密钥。

请求头

anthropic-beta

string

必填

请求体

application/json

url

string<uri>

必填

name

string

必填

enabled_events

enum<string>[]

必填

Minimum array length: 1

可用选项:

session.status_run_started,

session.status_idled,

session.status_rescheduled,

session.status_terminated,

session.deleted,

session.updated,

session.error,

session.thread_created,

session.thread_status_running,

session.thread_status_idle,

session.thread_status_rescheduled,

session.thread_status_terminated,

session.thread_idled,

session.thread_terminated,

session.outcome_evaluation_ended,

vault.created,

vault.archived,

vault.deleted,

vault_credential.created,

vault_credential.archived,

vault_credential.deleted,

vault_credential.refresh_failed

description

string

默认值:""

响应

200 - application/json

成功响应（OK）

id

string

必填

示例:

"wh_01H..."

type

string

必填

Allowed value: "webhook"

url

string<uri>

必填

name

string

必填

description

string

必填

enabled_events

enum<string>[]

必填

可用选项:

session.status_run_started,

session.status_idled,

session.status_rescheduled,

session.status_terminated,

session.deleted,

session.updated,

session.error,

session.thread_created,

session.thread_status_running,

session.thread_status_idle,

session.thread_status_rescheduled,

session.thread_status_terminated,

session.thread_idled,

session.thread_terminated,

session.outcome_evaluation_ended,

vault.created,

vault.archived,

vault.deleted,

vault_credential.created,

vault_credential.archived,

vault_credential.deleted,

vault_credential.refresh_failed

status

enum<string>

必填

可用选项:

enabled,

disabled

created_at

string<date-time>

必填

updated_at

string<date-time>

必填

disabled_reason

string | null

创建 Webhook

curl --request POST \
  --url http://localhost:38080/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "enabled_events": []
}
'

import requests

url = "http://localhost:38080/v1/webhooks"

payload = {
    "url": "<string>",
    "name": "<string>",
    "enabled_events": []
}
headers = {
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'anthropic-beta': '<anthropic-beta>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', name: '<string>', enabled_events: []})
};

fetch('http://localhost:38080/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"enabled_events\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "wh_01H...",
  "type": "webhook",
  "url": "<string>",
  "name": "<string>",
  "description": "<string>",
  "enabled_events": [
    "session.status_run_started"
  ],
  "status": "enabled",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "disabled_reason": "<string>"
}