Create Webhook Subscription

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Accept

string

optional

Example:

application/json

Body Params application/json

url

string

required

This is the API endpoint where the webhook notification will be delivered.

>= 1 characters<= 512 characters

events

array[string]

required

A supplied agreement identifier.

>= 1 items

Allowed values:

direct_debit.cleareddirect_debit.faileddisbursement.cleareddisbursement.faileddisbursement.change_railsdisbursement.cancelledpayid.activatedpayid.failedpayid.disabledpayid.deregisteredpayto_agreement.activatedpayto_agreement.declinedpayto_agreement.expiredpayto_agreement.failedpayto_agreement.cancelledpayto_agreement.reactivatedpayto_agreement.suspendedpayto_agreement.amendedpayto_payment.clearedpayto_payment.failedpayto_payment.under_investigationreceivable.cleared

Example

{
  "url": "https://webhook.site/some-uuid",
  "events": [
    "payto_agreement.activated",
    "payto_payment.cleared"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-sandbox.squarepay.com.au/v2/webhook-subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "url": "https://webhook.site/some-uuid",
    "events": [
        "payto_agreement.activated",
        "payto_payment.cleared"
    ]
}'

Responses

🟢201OK

application/json

Body

data

object (WebhookSubscription)

required

webhook_subscription_id

string

required

<= 36 characters

url

string

required

This is the API endpoint where the webhook notification will be delivered.

>= 1 characters<= 512 characters

signature_secret

string

required

events

array[string]

required

A supplied agreement identifier.

>= 1 items

Allowed values:

direct_debit.cleareddirect_debit.faileddisbursement.cleareddisbursement.faileddisbursement.change_railsdisbursement.cancelledpayid.activatedpayid.failedpayid.disabledpayid.deregisteredpayto_agreement.activatedpayto_agreement.declinedpayto_agreement.expiredpayto_agreement.failedpayto_agreement.cancelledpayto_agreement.reactivatedpayto_agreement.suspendedpayto_agreement.amendedpayto_payment.clearedpayto_payment.failedpayto_payment.under_investigationreceivable.cleared

status

enum<string>

required

Allowed values:

ACTIVEDELETED

Example

{
  "data": {
    "webhook_subscription_id": "7e9f4299-6049-4c11-abed-dcdb27102e33",
    "url": "https://webhook.site/some-uuid",
    "signature_secret": "YpG4przYWpXqn7Q6pw16G2D47762UhF0LcLlBjn59oMDOh7SfujaV6EcgOd6merv",
    "events": [
      "payto_agreement.activated",
      "payto_payment.cleared"
    ],
    "status": "ACTIVE"
  }
}

🟠401Unauthorised

🟠422Unprocessable Entity

🔴500Server Error