Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Nozle-Signature
string
required

Signature of the webhook payload

Example:

"Ap¶5É¿ŸÎ£6ÐfV£Ä\u0015\u0015ºõÔõÔ[D‹æAâÿüÚ"

X-Nozle-Signature-Algorithm
enum<string>
required

Algorithm used to generate the signature

Available options:
jwt,
hmac
Example:

"hmac"

X-Nozle-Unique-Key
string<uuid>
required

Unique id of the webhook. It can be used for idempotency

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

Body

application/json

Details of the plan

webhook_type
enum<string>
required
Available options:
plan.updated
object_type
enum<string>
required
Available options:
plan
organization_id
string<uuid>
required

Unique identifier of the organization, created by Nozle.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

plan
object
required

A plan. This is the object returned by GET /plans, GET /plans/{code} and the plan write endpoints.

With a publishable pk_ key, GET /plans and GET /plans/{code} return this whole object, including prices, charges, taxes, minimums, credit grants and metadata. Nothing is filtered or redacted. See "Publishable keys" on those operations.

charges, entitlements, usage_thresholds, applicable_usage_thresholds, taxes, credit_grant_rules and credit_pool_policies are always present in a plan returned by the plan endpoints. They are empty arrays when the plan has none.

Response

200

Return a 2xx status within 30 seconds to acknowledge the delivery. Any other status, a timeout or a connection error is a failed attempt; Nozle makes up to 3 attempts.