Edit

Share via

Update subscriptions (v1.0)

  • Article

Updates a subscriptions object for Business Central. A subscription is valid for 3 days unless it is updated. PATCH requests will perform a handshake with the subscriber.

Custom APIs

If you're subscribing to a custom API page, both the URL you send the subscription HTTP request to and the resource path you wish to subscribe to must include the <APIPublisher>, <APIGroup>, and <APIVersion> elements equivalent to: api/<APIPublisher>/<APIGroup>/<APIVersion>/subscriptions. For example, if your API publisher is pub, your API group is grp, and the version is 1.0, part of the URL will contain these elements api/pub/grp/v1.0/subscriptions.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

PATCH businesscentralPrefix/subscriptions({id})

Request headers (v1.0)

Header Value
Authorization Bearer {token}. Required.
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the subscription, the subscription will not be updated.

Request body (v1.0)

Here is an example of the request.

PATCH https://{businesscentralPrefix}/api/v1.0/subscriptions({'id'})
Content-type: application/json

{
  "notificationUrl": "https://{notificationUrl}",
  "resource": "/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
  "clientState": "optionalValueOf2048"
}

Response (v1.0)

If successful, this method returns a 200 OK response code and a subscription object in the response body.

Example (v1.0)

Request

Here is an example of the request.

https://{businesscentralPrefix}/api/v1.0/subscriptions({'id'})

Response Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{
  "subscriptionId": "c670ea73cacb459bb51dc1740da2f1db",
  "notificationUrl": "https://contoso.com/myCallbacks",
  "resource": "companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
  "userId": "00000000-0000-0000-0000-000000000001",
  "lastModifiedDateTime": "2018-10-12T12:32:35Z",
  "clientState": "anytextvalueof2048",
  "expirationDateTime": "2018-10-15T12:32:35Z"
}

Important

Handshake is mandatory when creating a subscription and renewing a subscription. See Working with Webhooks.

Tips for working with the APIs

Error Codes
Subscription Resource Type
Get subscriptions
Create subscriptions
Delete subscriptions
Microsoft REST API Guidelines