DELETE/api/v1/inbound-webhooks/{id}/capture-sample

Product availabilityAlgaPSA

Clear inbound webhook sample payload

Clears the saved sample payload and disables sample capture.

RBAC · inbound_webhook

Path parameters

idstring <uuid>Required

Inbound webhook UUID.

Response body

Success response 200

dataobjectRequired

inboundWebhookIdstring <uuid>Required

tenantstring <uuid>Required

namestringRequired

slugstringRequired

descriptionstringRequiredNullable

authTypestringRequired

Enum: hmac_sha256bearerip_allowlistpath_token

authConfigobjectRequired

Redacted auth configuration metadata.

idempotencySourceobjectRequiredNullable

typestringRequired

Enum: headerjsonata

valuestringRequired

idempotencyWindowSecondsintegerRequired

handlerTypestringRequired

Enum: direct_actionworkflow

handlerConfigobjectRequired

samplePayloadany

sampleCaptureExpiresAtstring <date-time>RequiredNullable

isActivebooleanRequired

rateLimitPerMinuteintegerRequired

autoDisabledAtstring <date-time>RequiredNullable

createdBystring <uuid>RequiredNullable

createdAtstring <date-time>Required

updatedAtstring <date-time>Required

secretstringNullable

Response codes

200

Sample payload cleared.

400

Invalid inbound webhook request.

401

Missing or invalid authenticated user context.

403

Inbound webhook permission denied.

404

Inbound webhook not found.

500

Unexpected inbound webhook operation failure.

DELETE /api/v1/inbound-webhooks/{id}/capture-sample

cURL

curl -X DELETE "https://algapsa.com/api/v1/inbound-webhooks/{id}/capture-sample" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/inbound-webhooks/{id}/capture-sample", {
  method: "DELETE",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Delete, "https://algapsa.com/api/v1/inbound-webhooks/{id}/capture-sample");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "inboundWebhookId": "01HN2K7VRB9PQ3Y0000000000",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "name": "string",
    "slug": "string",
    "description": "string",
    "authType": "hmac_sha256",
    "authConfig": {},
    "idempotencySource": {
      "type": "header",
      "value": "string"
    },
    "idempotencyWindowSeconds": 1,
    "handlerType": "direct_action",
    "handlerConfig": {},
    "samplePayload": null,
    "sampleCaptureExpiresAt": "2026-04-18T15:22:14Z",
    "isActive": false,
    "rateLimitPerMinute": 1,
    "autoDisabledAt": "2026-04-18T15:22:14Z",
    "createdBy": "01HN2K7VRB9PQ3Y0000000000",
    "createdAt": "2026-04-18T15:22:14Z",
    "updatedAt": "2026-04-18T15:22:14Z"
  },
  "secret": "string"
}