Registra un endpoint (il segreto di firma è restituito una sola volta)

POST

/api/admin/v1/establishments/{establishmentId}/webhook-endpoints

curl --request POST \
  --url https://example.com/api/admin/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --cookie arenile_session=<arenile_session> \
  --data '{ "url": "example", "description": "example", "events": [ "example" ], "active": true }'

• Stessa origine dell'istanza Arenile

URL https (http solo verso localhost/127.0.0.1/::1, per sviluppo), senza credenziali nella URL, massimo 2048 caratteri. Eventi: tipi di WebhookEventType, <gruppo>.* o *. Il segreto whsec_… è cifrato a riposo (AES-GCM, ARENILE_SECRET_KEY) e compare solo in questa risposta. Niente Idempotency-Key (la risposta contiene il segreto). Audit webhook.created.

Authorizations

• cookieAuth

Parameters

Path Parameters

establishmentId

required

string format: uuid

Header Parameters

X-CSRF-Token

string

Obbligatorio per le richieste autenticate via cookie che modificano dati: deve coincidere con il valore del cookie arenile_csrf.

Request Body^required

Media typeapplication/json

object

url

required

string

>= 8 characters <= 2048 characters

description

string

<= 200 characters

events

required

Array<string>

>= 1 items <= 50 items

active

boolean

default: true

Responses

201

Endpoint creato

Media typeapplication/json

object

endpoint

required

object

id

required

string format: uuid

url

required

string

description

required

string

events

required

Array<string>

active

required

boolean

status

required

Active; paused (disattivato dal gestore); disabled (disattivato automaticamente dopo errori ripetuti).

string

Allowed values: active paused disabled

consecutive_failures

required

integer

disabled_at

string format: date-time

disabled_reason

string

previous_secret_expires_at

Fine del periodo di grazia del segreto precedente, se in corso.

string format: date-time

last_delivery_at

Ultimo tentativo di consegna (qualsiasi esito).

string format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

secret

required

Segreto di firma whsec_…, mostrato solo ora.

string

Example

{
  "endpoint": {
    "status": "active"
  }
}

400

Richiesta non valida

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

401

Autenticazione assente o non valida

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

403

Permesso negato

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

404

Risorsa inesistente

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

501

Operazione non ancora disponibile (not_implemented)

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}