Manage Subscriptions

Update a specific subscription created by your application

Updates the subscription callback URL and/or the subscription status to be either active or track only for the given Subscription ID. Updating the status to be track only will pause updates being sent to the requested callback URL

SecurityOAuth2_Security_Scheme
Request
path Parameters
subscriptionId
required
string [ 0 .. 24 ] characters ^[a-z0-9-]{1,24}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Request Body schema: application/json
object (WebhookStatusUpdateSchema)
callbackUrl
string [ 0 .. 300 ] characters ^http[\S\s]{1,300}$
Responses
200

All good!

401

Unauthorised

404

You do not currently have any subscriptions

405

Method is not allowed

500

Something went wrong on our side

patch/v2/webhook/subscription/{subscriptionId}
Request samples
application/json

Update Subscription

{}
Response samples
application/json

200 Update Success

{
  • "subscriptionDetails": {
    },
  • "subscriptionId": "61406222b65cf749ea893c1a",
  • "type": "resourceMonitoringId"
}

Remove a subscription created by your application

Deletes a subscription created by your application based onthe given Subscription ID. Deleting a subscription will stop updates being sent to the requested callback URL

SecurityOAuth2_Security_Scheme
Request
path Parameters
subscriptionId
required
string [ 0 .. 24 ] characters ^[a-z0-9-]{1,24}$
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

401

Unauthorised

404

You do not currently have any subscriptions

500

Something went wrong on our side

delete/v2/webhook/subscription/{subscriptionId}
Request samples
Response samples
application/json

200 Delete Successful

{
  • "subscriptionDetails": {
    },
  • "subscriptionId": "6141b9bcb65cf749ea893c45",
  • "type": "resourceMonitoringId"
}

Retrieve a list of subscriptions created by your application

Returns a list of active or paused subscriptions and the corresponding Subscription IDs that were created by your application

SecurityOAuth2_Security_Scheme
Request
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Responses
200

All good!

204

You do not currently have any subscriptions

401

Unauthorised

500

Something went wrong on our side

get/v2/webhook/subscriptions
Request samples
Response samples
application/json

200 List Subscriptions

[
  • {
    },
  • {
    }
]