Delete webhook

Delete a webhook. Required API-key scope: webhooks_manage; the key’s owner must still be allowed to manage webhooks. A member session needs permission to manage webhooks or credentials.

DELETE /api/v1/workspaces/{workspaceId}/webhooks/{webhookId}

Delete a webhook

cURL

curl --request DELETE \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'

400

{
  "docUrl": "<string>",
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "timestamp": "2023-11-07T05:31:56Z",
  "details": {
    "capabilityBlockers": [
      {
        "code": "WORKSPACE_NOT_FOUND",
        "estimate": "minutes",
        "message": "<string>",
        "unlockStep": "finishOnboarding",
        "currentlyDue": [
          "<string>"
        ]
      }
    ],
    "conflicts": [
      "<string>"
    ],
    "consentedWindow": {
      "cadence": {
        "dayBasis": "calendarDays",
        "kind": "intraday",
        "everyHours": 1,
        "localTimes": [
          "<string>"
        ]
      },
      "scheduleId": "<string>",
      "scheduleLabel": "<string>",
      "scheduleVersion": 123,
      "snapshotAt": "2023-11-07T05:31:56Z",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assumedBoundary": {
        "lpName": "<string>",
        "source": "<string>",
        "timeZone": "<string>"
      },
      "cutoffAt": "2023-11-07T05:31:56Z",
      "paymentDeadlineAt": "2023-11-07T05:31:56Z",
      "settlementBasis": "clock",
      "settlesBy": "2023-11-07T05:31:56Z",
      "statementIssuer": "<string>"
    },
    "currentWindow": {
      "cadence": {
        "dayBasis": "calendarDays",
        "kind": "intraday",
        "everyHours": 1,
        "localTimes": [
          "<string>"
        ]
      },
      "scheduleId": "<string>",
      "scheduleLabel": "<string>",
      "scheduleVersion": 123,
      "snapshotAt": "2023-11-07T05:31:56Z",
      "windowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assumedBoundary": {
        "lpName": "<string>",
        "source": "<string>",
        "timeZone": "<string>"
      },
      "cutoffAt": "2023-11-07T05:31:56Z",
      "paymentDeadlineAt": "2023-11-07T05:31:56Z",
      "settlementBasis": "clock",
      "settlesBy": "2023-11-07T05:31:56Z",
      "statementIssuer": "<string>"
    },
    "field": "<string>",
    "reason": "clockUnavailable",
    "remediation": "<string>",
    "retryAfter": "PT120S",
    "value": "<string>"
  },
  "next": {
    "kind": "order"
  },
  "requestId": "<string>"
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

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

Scopes

webhooks_manage · bearer_auth

webhooks_manage · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Path Parameters

workspaceId · string · required

Workspace ID

webhookId · string · required

Webhook ID

Response

204

Webhook deleted