Create subscription
Creates a webhook subscription for Business Central. Will be created only if handshake is successful.
HTTP request
Replace the URL prefix for Business Central depending on environment following the guideline.
POST businesscentralPrefix/subscriptions
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json |
If-Match | Required. When this request header is included and the eTag provided does not match the current tag on the subscriptions, the subscriptions will not be updated. |
Request body
In the request body, supply a JSON representation of subscription object.
Response
If successful, this method returns a 201 Created
response code and a subscription object in the response body.
Example
Request
Here is an example of the request.
POST https://{businesscentralPrefix}/api/v1.0/subscriptions
Content-type: application/json
{
"subscriptionId": "c670ea73cacb459bb51dc1740da2f1db",
"notificationUrl": "https://contoso.com/myCallbacks",
"resource": "/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
"userId": "00000000-0000-0000-0000-000000000001",
"lastModifiedDateTime": "2018-10-12T12:32:35Z",
"clientState": "optionalvalueof2048",
"expirationDateTime": "2021-10-15T12:32:35Z",
"systemCreatedAt": "2017-01-23T00:24:31.766Z",
"systemCreatedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1",
"systemModifiedAt": "2020-08-21T00:24:31.777Z",
"systemModifiedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1"
}
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": "/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
"userId": "00000000-0000-0000-0000-000000000001",
"lastModifiedDateTime": "2018-10-12T12:32:35Z",
"clientState": "optionalvalueof2048",
"expirationDateTime": "2021-10-15T12:32:35Z",
"systemCreatedAt": "2017-01-23T00:24:31.766Z",
"systemCreatedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1",
"systemModifiedAt": "2020-08-21T00:24:31.777Z",
"systemModifiedBy": "f2a5738a-44e3-ea11-bb43-000d3a2feca1"
}
Important
Handshake is mandatory when creating a subscription and renewing a subscription. See Working with Webhooks.
See also
Tips for working with the APIs
Subscriptions
Get subscriptions
Delete subscriptions
Update subscriptions
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour