Create Webhook Endpoint

POST

webhooks

endpoints

Python

from polar.v2026_04 import Polar

polar = Polar("polar_oat_xxx")

response = polar.webhooks.create_webhook_endpoint(
    url='https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    api_version='2026-04',
    format='raw',
    events=['checkout.created'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2026-04";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.webhooks.createWebhookEndpoint(
  {
    "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
    "api_version": "2026-04",
    "format": "raw",
    "events": [
      "checkout.created"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "events": [],
  "name": "<string>",
  "api_version": "2026-04",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    events: [],
    name: '<string>',
    api_version: '2026-04',
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.polar.sh/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/webhooks/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    'events' => [
        
    ],
    'name' => '<string>',
    'api_version' => '2026-04',
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/webhooks/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/webhooks/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "api_version": "<string>",
  "format": "raw",
  "secret": "whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK",
  "organization_id": "<string>",
  "events": [
    "checkout.created"
  ],
  "enabled": true,
  "uses_standard_webhook_signature": true,
  "name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Body

application/json

url

string<uri>

required

The URL where the webhook events will be sent.

Required string length: 1 - 2083

Example:

"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"

format

enum<string>

required

The format of the webhook payload.

Available options:

raw,

discord,

slack

events

enum<string>[]

required

The events that will trigger the webhook.

Available options:

checkout.created,

checkout.updated,

checkout.expired,

customer.created,

customer.updated,

customer.deleted,

customer.state_changed,

customer_seat.assigned,

customer_seat.claimed,

customer_seat.revoked,

member.created,

member.updated,

member.deleted,

order.created,

order.updated,

order.paid,

order.refunded,

subscription.created,

subscription.updated,

subscription.active,

subscription.canceled,

subscription.uncanceled,

subscription.cycled,

subscription.revoked,

subscription.past_due,

subscription.paused,

subscription.resumed,

refund.created,

refund.updated,

product.created,

product.updated,

discount.created,

discount.updated,

discount.deleted,

benefit.created,

benefit.updated,

benefit_grant.created,

benefit_grant.cycled,

benefit_grant.updated,

benefit_grant.revoked,

organization.updated

name

string | null

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

api_version

enum<string>

default:2026-04

The API version that'll be used in event payloads.

Available options:

2026-04,

2026-10

organization_id

string<uuid4> | null

The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

Response

Webhook endpoint created.

A webhook endpoint.

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

string<uuid4>

required

The ID of the object.

url

string

required

The URL where the webhook events will be sent.

Example:

"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"

api_version

string

required

The API version that'll be used in event payloads.

format

enum<string>

required

The format of the webhook payload.

Available options:

raw,

discord,

slack

secret

string

required

The secret used to sign the webhook events.

Example:

"whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"

organization_id

string<uuid4>

required

The organization ID associated with the webhook endpoint.

events

enum<string>[]

required

The events that will trigger the webhook.

Available options:

checkout.created,

checkout.updated,

checkout.expired,

customer.created,

customer.updated,

customer.deleted,

customer.state_changed,

customer_seat.assigned,

customer_seat.claimed,

customer_seat.revoked,

member.created,

member.updated,

member.deleted,

order.created,

order.updated,

order.paid,

order.refunded,

subscription.created,

subscription.updated,

subscription.active,

subscription.canceled,

subscription.uncanceled,

subscription.cycled,

subscription.revoked,

subscription.past_due,

subscription.paused,

subscription.resumed,

refund.created,

refund.updated,

product.created,

product.updated,

discount.created,

discount.updated,

discount.deleted,

benefit.created,

benefit.updated,

benefit_grant.created,

benefit_grant.cycled,

benefit_grant.updated,

benefit_grant.revoked,

organization.updated

enabled

boolean

required

Whether the webhook endpoint is enabled and will receive events.

uses_standard_webhook_signature

boolean

required

read-only

Whether Polar signs deliveries to this endpoint with Standard Webhooks. False means Polar's original HMAC over the UTF-8 bytes of the full secret.

name

string | null

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

⌘I

Python

from polar.v2026_04 import Polar

polar = Polar("polar_oat_xxx")

response = polar.webhooks.create_webhook_endpoint(
    url='https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    api_version='2026-04',
    format='raw',
    events=['checkout.created'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2026-04";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.webhooks.createWebhookEndpoint(
  {
    "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
    "api_version": "2026-04",
    "format": "raw",
    "events": [
      "checkout.created"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/webhooks/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "events": [],
  "name": "<string>",
  "api_version": "2026-04",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    events: [],
    name: '<string>',
    api_version: '2026-04',
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  })
};

fetch('https://api.polar.sh/v1/webhooks/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/webhooks/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0',
    'events' => [
        
    ],
    'name' => '<string>',
    'api_version' => '2026-04',
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/webhooks/endpoints"

	payload := strings.NewReader("{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/webhooks/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/webhooks/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n  \"events\": [],\n  \"name\": \"<string>\",\n  \"api_version\": \"2026-04\",\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "url": "https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0",
  "api_version": "<string>",
  "format": "raw",
  "secret": "whsec_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK",
  "organization_id": "<string>",
  "events": [
    "checkout.created"
  ],
  "enabled": true,
  "uses_standard_webhook_signature": true,
  "name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Webhook Endpoint

Authorizations

Body

Response