Set up a subscription

This endpoint allows you to set up a new webhook subscription where you define the URL to where notifications will be sent. There are no limitations in the number of subscriptions that you can set up, meaning that you can listen to the same notifications on multiple URLs. Subscriptions cannot have identical URLs.

If you wish the notification to be active after the creation, set the status to 2, otherwise set the status to 1 which equals inactive. Use the activate and deactivate endpoints to turn them on or off.

The email field lets you specify an email that will be used to notify you if we cannot reach your endpoint, or if your endpoint does not reply with a 200 status code. You can read more about our retry strategy and email notifications in the guide on receiving and reading Webhooks. Note that this field is optional and that to unsubscribe from those emails, you'll need to remove the email from the subscription.

Once the subscription has been created, add events to it for which you wish to receive notifications for. The webhooks guide explains in more details how to set up subscriptions.

Body Params
string
required
length ≥ 1

URL where notifications are sent to

int32
enum
required

Status of the subscription

0 = None,
1 = Inactive,
2 = Active,
4 = Retired

Allowed:
string
required
length ≥ 1

32 characters encryption key provided by you

string | null
int32
5 to 1000

Maximum number of notifications per webhook message

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Internal Server Error. Something unexpected happened on BC Connect side.

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
text/plain
application/json
text/json