Create Subscription

Object containing data to make a request to create a subscription

JSON

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

Properties

Name	Type	Required	Restrictions	Description
eventSubscriptions	[string]	true	none	none
subscriptionURL	string(uri)	true	none	Subscriber endpoint to call with event
name	string	true	none	Name of subscription
auth	any	true	none	none

Type	Description
any	none

Name	Type	Required	Restrictions	Description
➥➥ anonymous	object	false	none	Represents sending of no Authorization header to the subscription endpoint
➥➥➥ authType	string	true	none	none

Name	Type	Required	Restrictions	Description
➥➥ anonymous	object	false	none	Represents sending of an Authorization header in format of https://www.ietf.org/rfc/rfc2617.txt. Will be sent in the format of "Basic base64(username:password)" to the subscription endpoint
➥➥➥ authType	string	true	none	none
➥➥➥ username	string	true	none	username to be sent in the Authorization header
➥➥➥ password	string	true	none	password to be sent in the Authorization header

Name	Type	Required	Restrictions	Description
➥➥ anonymous	object	false	none	Represents sending of an Authorization header in format of https://www.ietf.org/rfc/rfc6750.txt. Will be sent in the format of "Bearer token" to the subscription endpoint
➥➥➥ authType	string	true	none	none
➥➥➥ token	string	true	none	token to be sent in the Authorization header

Name	Type	Required	Restrictions	Description
➥ anonymous	string	false	none	none
➥➥ authType	string	true	none	none

Enumerated Values

Value
NONE
BASIC
STATIC_BEARER_TOKEN
NONE
BASIC
STATIC_BEARER_TOKEN