Create Subscription


Object containing data to make a request to create a subscription

{
  "eventSubscriptions": [
    "breadpayments.webhooks.my.super-rev1"
  ],
  "subscriptionURL": "https://example.com/callback",
  "name": "SubscriptionEndpoint-dbef2daf-f94a-41f3-8d07-52eb17cc17b3",
  "auth": {
    "authType": "BASIC",
    "username": "string",
    "password": "string"
  }
}

Properties

NameTypeRequiredRestrictionsDescription
eventSubscriptions[string]truenonenone
subscriptionURLstring(uri)truenoneSubscriber endpoint to call with event
namestringtruenoneName of subscription
authanyfalsenonenone
NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
➥➥ authTypestringtruenonenone
➥➥ usernamestringtruenonenone
➥➥ passwordstringtruenonenone
NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
➥➥ authTypestringtruenonenone

Enumerated Values

Value
BASIC
NONE