Update a webhook endpoint

PATCH

/v1/projects/{projectId}/webhook-endpoints/{endpointId}

curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/webhook-endpoints/{endpointId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "string",
    "description": "string",
    "eventTypes": [
      "string"
    ],
    "status": "active"
  }'

认证

每个请求都需要携带个人访问令牌（PAT）。

Authorization: Bearer PAT

认证指南

路径参数

projectIdstring必填
endpointIdstring必填

请求头参数

If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

请求体

Content-Typeapplication/json

urlstring
descriptionstring | null
eventTypesarray<string>
statusstring
可选值
active
disabled

响应

Success

dataobject必填
- idstring必填
- tenantIdstring必填
- projectIdstring | null必填
- urlstring必填
- descriptionstring | null必填
- eventTypesarray<string>必填
- statusstring必填
  可选值
  active
  disabled
  disabled_by_platform
- secretVersionnumber必填
- previousSecretExpiresAtstring | null必填
- consecutiveFailureCountnumber必填
- lastFailureAtstring | null必填
- lastSuccessAtstring | null必填
- disabledAtstring | null必填
- createdAtstring必填
- updatedAtstring必填
metaobject必填
- requestIdstring必填

响应示例

{
  "data": {
    "id": "string",
    "tenantId": "string",
    "projectId": "string",
    "url": "string",
    "description": "string",
    "eventTypes": "recording.processed",
    "status": "active",
    "secretVersion": 0,
    "previousSecretExpiresAt": "string",
    "consecutiveFailureCount": 0,
    "lastFailureAt": "string",
    "lastSuccessAt": "string",
    "disabledAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1

curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/webhook-endpoints/{endpointId}' \ -H 'Authorization: Bearer $EMBODIFLOW_PAT' \ -H 'Content-Type: application/json' \ -d '{ "url": "string", "description": "string", "eventTypes": [ "string" ], "status": "active" }'

{ "data": { "id": "string", "tenantId": "string", "projectId": "string", "url": "string", "description": "string", "eventTypes": "recording.processed", "status": "active", "secretVersion": 0, "previousSecretExpiresAt": "string", "consecutiveFailureCount": 0, "lastFailureAt": "string", "lastSuccessAt": "string", "disabledAt": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string" } }