Skip to main content

Unsubscribing to Webhooks

Calling this endpoint will cause you to stop receiving notifications for the events or categories of events you specify. This is a PUT request.

Parameters

    Content-Type String - (Required)
    application-json

    Accept String - (Required)
    application-json

    Authorization String - (Required)
    Bearer {ACCESS_TOKEN} (See Authentication)

    subscriptionId String - (Required)
    Subscription key received when subscribing to webhook

    subscriptionDetails Object - (Required)
    See subscription details object below

subscriptionDetails

    type enum - (Required)
    EVENT or CATEGORY or ALL

    details String - (Required)
    If type is CATEGORY, this should be a list of ACCOUNT, CUSTOMER and/or PAYMENT. If type is EVENT, this should be a list of events from the events table below. If type is ALL, this value is optional.

Returns

    subscriptionKey String
    A unique key for this subscription. Can be used to unsubscribe from webhooks

Post Request

PUT - /v1/webhook/unsubscribe
POST Request
1curl --location --request POST '{API_BASE_URL}/v1/webhook/subscribe' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer {ACCESS_TOKEN}' \
4--data-raw '{ 
5	"url":"{URL}", 
6	"secretKey":"{SECRET_KEY}", 
7	"subscriptionDetails" : { 
8		"type" : "CATEGORY", 
9		"details" : ["CUSTOMER","ACCOUNT","PAYMENT"] 
10	} 
11}'

Response Body

Response
1{ "subscriptionKey" : "4fa54dcce-32b9-8c8c-7344-1e8f4b41826" }