Webhooks

Create webhook endpoint

Creates an environment-specific HTTPS webhook endpoint after SSRF-safe URL validation.

Required scope: webhooks:manage.

post/api/v1/webhook-endpoints

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Headers

Idempotency-Keystring required

Required for resource-creating POST requests. The same key and identical body replay the original response for 24 hours; a different body returns idempotency_conflict.

Request body

urlstring uri required
event_typesWebhookEventType[] required

Response

Webhook endpoint created; the signing secret is shown once.

idstring required
urlstring uri required
event_typesWebhookEventType[] required
is_activeboolean required
secretstring required

HMAC signing secret. Returned only at creation.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.