Subscription

{
  "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"
    }
  ]
}

Object containing subscription data returned for successful requests

Properties

NameTypeRequiredRestrictionsDescription
namestringtruenoneName of subscription
subscriptionURLstring(uri)truenoneSubscriber endpoint to call with event
eventSubscriptions[string]truenonenone
keys[object]truenonenone
➥ kstringtruenonebase64 URL encoded key
➥ ktystringtruenonekey type
➥ kidstringtruenonekey id
➥ usestringtruenoneintended use
➥ algstringtruenonealgorithm used to encode signature