Subscription

JSON

{
  "name": "SubscriptionEndpoint-dbef2daf-f94a-41f3-8d07-52eb17cc17b3",
  "subscriptionURL": "https://example.com/callback",
  "eventSubscriptions": [
    "breadpayments.webhooks.my.super-rev1"
  ],
  "keys": [
    {
      "k": "string",
      "kty": "string",
      "kid": "string",
      "use": "string",
      "alg": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Object containing subscription data returned for successful requests
➥ name	string	true	none	Name of subscription
➥ subscriptionURL	string(uri)	true	none	Subscriber endpoint to call with event
➥ eventSubscriptions	[string]	true	none	none

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Object containing subscription data returned for successful requests
➥ keys	[object]	true	none	none
➥➥ k	string	true	none	base64 URL encoded key
➥➥ kty	string	true	none	key type
➥➥ kid	string	true	none	key id
➥➥ use	string	true	none	intended use
➥➥ alg	string	true	none	algorithm used to encode signature