Update Webhook Endpoint

View Markdown

Update a webhook endpoint.

PATCH
/webhooks/endpoints/{id}

Authorization

AuthorizationRequiredBearer <token>

API key authentication using "Authorization: Bearer <api_key>" header. Use your project API key (ittybit_*).

In: header

Request Body

application/jsonOptional
namestring
urlstring
Format: "uri"
topicsarray<string>
statusstring
Value in: "active" | "paused"

Path Parameters

idRequiredstring

Response Body

Default Response

idRequiredstring
objectRequiredstring
Value in: "webhook_endpoint"
nameRequiredstring
urlRequiredstring
Format: "uri"
topicsRequiredarray<string>
statusRequiredstring
Value in: "active" | "paused" | "disabled"
verified_atRequirednumber
created_atRequirednumber
updated_atRequirednumber
secretRequiredstring
{
  "id": "we_3nF8tGy1bK",
  "object": "webhook_endpoint",
  "name": "Production webhook",
  "url": "https://example.com/webhooks/ittybit",
  "topics": [
    "task.succeeded",
    "task.failed",
    "run.succeeded",
    "run.failed"
  ],
  "status": "active",
  "secret": "whsec_MIGfMA0GCSqGSIb3DQEBA...",
  "verified_at": 1735689600,
  "created_at": 1735689600,
  "updated_at": 1735689600
}

Get Webhook EndpointGET

Previous Page

Delete Webhook EndpointDELETE

Next Page