POpolar
webhooks
public

Create Webhook Endpoint

Changed on

Create a webhook endpoint.

Scopes: webhooks:write

post/v1/webhooks/endpoints

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/webhooks/endpoints
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: webhooks:write)
    • or HTTP bearer
    • or HTTP bearer

Request body

urlstring uri required

The URL where the webhook events will be sent.

namestring nullable

An optional name for the webhook endpoint to help organize and identify it.

format'raw' | 'discord' | 'slack' required
eventsWebhookEventType[] required

The events that will trigger the webhook.

organization_idstring uuid4 nullable

The organization ID.

Example request

{
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}

Response

Webhook endpoint created.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

urlstring required

The URL where the webhook events will be sent.

namestring nullable

An optional name for the webhook endpoint to help organize and identify it.

format'raw' | 'discord' | 'slack' required
secretstring required

The secret used to sign the webhook events.

organization_idstring uuid4 required

The organization ID associated with the webhook endpoint.

eventsWebhookEventType[] required

The events that will trigger the webhook.

enabledboolean required

Whether the webhook endpoint is enabled and will receive events.

Example response

{
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "secret": "whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"
}

Changes

  • 2bc8253676a5Revision changes
    • warning

      added the new discount.created enum value to the / response property for the response status

    • warning

      added the new discount.deleted enum value to the / response property for the response status

    • warning

      added the new discount.updated enum value to the / response property for the response status

    • warning

      added the new subscription.cycled enum value to the / response property for the response status

    • info

      added the new discount.created enum value to the request property /

    • info

      added the new discount.deleted enum value to the request property /

    • info

      added the new discount.updated enum value to the request property /

    • info

      added the new subscription.cycled enum value to the request property /