Webhook endpoints

Delete a webhook endpoint

DELETE/v1/webhooks/{endpoint_id}

Deletes the endpoint and its pending deliveries, failures and counters. Irreversible.

Required scopewrite:webhooks

Rate limit60 requests per minute

curl -X DELETE 'https://api.fansquare.so/v1/webhooks/67a55c69-e54b-4b90-a9f9-e000f12eb3fd' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "type": "https://developers.offmy.co/errors/validation_failed",
  "title": "Validation failed",
  "status": 400,
  "instance": "/v1/webhooks/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/endpoint_id",
      "schemaPath": "#/endpoint_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "endpoint_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "endpoint_id"
    }
  ]
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Path

endpoint_idstringrequired
Webhook endpoint id (the id field of endpoint items).
format uuid

Response

No content

No response body

curl -X DELETE 'https://api.fansquare.so/v1/webhooks/67a55c69-e54b-4b90-a9f9-e000f12eb3fd' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "type": "https://developers.offmy.co/errors/validation_failed",
  "title": "Validation failed",
  "status": 400,
  "instance": "/v1/webhooks/12345",
  "errors": [
    {
      "keyword": "invalid_string",
      "instancePath": "/endpoint_id",
      "schemaPath": "#/endpoint_id/invalid_string",
      "params": {
        "issue": {
          "code": "invalid_string",
          "validation": "uuid",
          "path": [
            "endpoint_id"
          ],
          "message": "Invalid uuid"
        }
      },
      "message": "Invalid uuid",
      "path": "endpoint_id"
    }
  ]
}