Edit

Share via

subscriptions resource type

Represents a subscriptions in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

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.

Methods

Method Return Type Description
GET subscriptions subscriptions Gets a subscriptions object.
DELETE subscriptions none Deletes a subscriptions object.
POST subscriptions subscriptions Creates a subscriptions object.
PATCH subscriptions subscriptions Updates a subscriptions object.

Properties

Property Type Description
subscriptionId string Unique key for the subscription.
notificationUrl string URL to which webhook notifications are sent.
resource string URL for the resource being subscribed to. Supports relative and absolute URL.
timestamp int64
userId GUID The ID of user that has created the subscriptions.
lastModifiedDateTime datetime The last datetime the subscriptions was modified. Read-Only.
clientState string Client state will be delivered with every notification. This can be used as a secret to verify message or for managing state if needed.
expirationDateTime datetime Date and time for when the webhook will expire.
systemCreatedAt datetime The datetime the company was created.
systemCreatedBy GUID The ID of the user who created the company.
systemModifiedAt datetime The last datetime the subscriptions was modified.
systemModifiedBy GUID The ID of the user who last modified the company.

JSON representation

Here's a JSON representation of the subscriptions resource.

{
    "subscriptionId": "string",
    "notificationUrl": "string",
    "resource": "string",
    "timestamp": "int64",
    "userId": "GUID",
    "lastModifiedDateTime": "datetime",
    "clientState": "string",
    "expirationDateTime": "datetime",
    "systemCreatedAt": "datetime",
    "systemCreatedBy": "GUID",
    "systemModifiedAt": "datetime",
    "systemModifiedBy": "GUID"
}

GET subscriptions
DELETE subscriptions
POST subscriptions
PATCH subscriptions