PATCH/webhook-endpoints/{id}

Update a webhook endpoint or its subscriptions

Bearer Tokenwebhooks:manage

Request

curl · Sandboxbash

curl --request PATCH \
  'https://sandbox-api.padel-lab.crewio.co/v1/club/webhook-endpoints/resource_01JABC' \
  --header 'Authorization: Bearer $PADEL_LAB_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Primary event receiver",
  "event_types": [
    "booking.updated",
    "match.completed"
  ],
  "status": "ACTIVE"
}'

Parameter

idpathIdrequired

Request Body

WebhookEndpointPatchrequired

Examplejson

{
  "name": "Primary event receiver",
  "event_types": [
    "booking.updated",
    "match.completed"
  ],
  "status": "ACTIVE"
}

JSON Schema anzeigen

{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 120,
      "x-runtime-normalization": "trim-before-length-validation"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "pattern": "^[Hh][Tt][Tt][Pp][Ss]://",
      "description": "Public HTTPS URL without user information or a fragment. Private and reserved networks are rejected after DNS resolution."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500,
      "x-runtime-normalization": "trim-before-length-validation"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "DISABLED"
      ]
    },
    "event_types": {
      "type": "array",
      "minItems": 1,
      "maxItems": 12,
      "items": {
        "type": "string",
        "enum": [
          "booking.created",
          "booking.updated",
          "booking.cancelled",
          "booking.reconciliation_required",
          "session.created",
          "session.status_changed",
          "participant.updated",
          "match.started",
          "score.updated",
          "score.corrected",
          "match.completed",
          "court.status_changed"
        ]
      },
      "description": "Duplicate values are accepted and normalized to one subscription."
    }
  }
}

Responses

200Webhook endpoint updatedWebhookEndpointResponse

400Malformed JSON or a syntactically valid request that violates a path, query, header or JSON-body constraint.ErrorResponse

401Missing, invalid or expired tokenErrorResponse

403Installation lacks the required scope or is inactiveErrorResponse

404Resource is absent or outside the token-bound tenantErrorResponse

429Rate limit exceededErrorResponse

500An unexpected runtime error occurred; retry only when the operation is safe or idempotent.ErrorResponse

503A required authorization, tenant-safety or rate-limit dependency is unavailableErrorResponse

Response Schemas

WebhookEndpointResponseStatus 200

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id",
        "name",
        "url",
        "description",
        "status",
        "event_types",
        "signing_secret_version",
        "consecutive_failures",
        "last_failure_at",
        "disabled_at",
        "created_at",
        "updated_at"
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200,
          "description": "Opaque stable identifier"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "ACTIVE",
            "DISABLED"
          ]
        },
        "event_types": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "booking.created",
              "booking.updated",
              "booking.cancelled",
              "booking.reconciliation_required",
              "session.created",
              "session.status_changed",
              "participant.updated",
              "match.started",
              "score.updated",
              "score.corrected",
              "match.completed",
              "court.status_changed"
            ]
          },
          "uniqueItems": true
        },
        "signing_secret_version": {
          "type": "integer",
          "minimum": 1
        },
        "consecutive_failures": {
          "type": "integer",
          "minimum": 0
        },
        "last_failure_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "disabled_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "UTC RFC 3339 timestamp"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "UTC RFC 3339 timestamp"
        }
      }
    }
  }
}

ErrorResponseStatus 400, 401, 403, 404, 429, 500, 503

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code",
        "message",
        "request_id"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable code. Clients must tolerate unknown codes within the same HTTP class.",
          "examples": [
            "invalid_request",
            "invalid_cursor",
            "IDEMPOTENCY_KEY_REQUIRED",
            "unsafe_webhook_url",
            "authentication_required",
            "invalid_token",
            "insufficient_scope",
            "installation_inactive",
            "not_found",
            "VERSION_CONFLICT",
            "UNMAPPED_COURT",
            "IDEMPOTENCY_CONFLICT",
            "IDEMPOTENCY_IN_PROGRESS",
            "endpoint_limit_reached",
            "rate_limited",
            "internal_error",
            "idempotency_replay_failed",
            "authorization_unavailable",
            "rate_limit_unavailable"
          ]
        },
        "message": {
          "type": "string"
        },
        "request_id": {
          "type": "string"
        },
        "details": {}
      }
    }
  }
}