Webhooks

Create a webhook endpoint

Changed on

Registers a URL to receive deliveries for the event types listed in events. The url must be publicly reachable over HTTP(S) — private, internal, and loopback addresses are rejected.

The response is the only time the signing secret is returned in plaintext. Store it securely; you need it to verify the signature on every delivery. If you lose it, rotate the secret to get a new one.

Note: This resource supersedes the legacy Webhooks resource. Legacy webhooks keep working, but new integrations should be built here — see getting started for a full walkthrough.

post/v4/webhook_endpoints

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/webhook_endpoints
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Request body

urlstring required
eventsstring[] required

Event types this endpoint subscribes to (e.g. subscriber.created). On update, the list supplied here replaces the endpoint's full subscription list.

namestring
descriptionstring

Response

Creates a webhook endpoint

Changes