How to – Use Custom API to create custom messages in Dynamics 365
Custom API (preview) allows us to define our custom messages that can be called from web services, similar to Custom Actions. Usually, we would be creating custom workflow actions just to create a new message, to which we can hook our plugin, without defining any logic in the workflow. For this scenario or pattern now we can use Custom API instead.
There are different ways of creating a custom API.
Through the Maker Portal.
Using Web API or Organization Service.
Editing the solution files.
The 3 key entities involved here are
CustomAPI
CustomAPIRequestParameter
CustomAPIResponseProperty
Let us try creating a CustomAPI through the maker portal.
Create a new solution, and click on New and select Custom API
Let us start with a very basic custom action.
Unique Name
This will be the name of the message. Should have the prefix same as solution’s publisher.
Name
The name of the Custom API will show up inside the solution
Display Name
Localized display name of the Custom API
Description
Localized description of the Custom API
Binding Type
Value: 0 Label: Global
Value: 1 Label: Entity
Value: 2 Label: EntityCollection
Bound Entity Logical Name
Logical name of the entity in case of binding type – Entity and EntityCollection.
Is Function
Value: 0 Label: No
Value: 1 Label: Yes
Allowed Custom Processing Step Type
Value: 0 Label: None Meaning: No custom processing steps allowed.
Value: 1 Label: Async Only Meaning: Only asynchronous custom processing steps allowed
Value: 2 Label: Sync and Async Meaning: No restriction. 3rd party plug-ins can add synchronous logic to change the behavior of the message
Execute Privilege Name
Name of the Privilege that is required for the execution of the Custom API.
Plugin Type
Reference of the plugin registered for the Custom API
So right now we have a very basic custom API registered of Global type, which doesn’t allow any steps to be registered and doesn’t need any privileges to execute
Let us write a sample plugin and associate with this new message.
Let us register the assembly
Now let us go back to our Custom API record and associate the Plugin registered.
Let us trigger the plugin by calling the Custom API through the Postman.
Let us check the plugin trace log inside Dynamics 365 App.
Recently while designing the custom page, we realized that the format property is missing for the Date Picker control. This is because Date Picker control is based on Fluent UI Library. One option earlier…
Example of applying filter to select only those Journey records that are in draft state and records having ‘copy’ work in its name. Also checked – Do not update existing records. On importing in…
Let us take one of the out-of-the-box marketing forms available in Dynamics 365 Marketing. It has only an Email field marked as required and creates / updates both contacts and leads. If we click…
Just sharing the sample formula, we used for associating selected products from the gallery to lead on OnSelect of a button. Here collectionCheckedProducts contains the checked products from the gallery bound to the product…
Recently we were working on Facebook Leads integration with Dynamics 365. Webhook for Leads can be configured to send real-time notifications of the Leads ads changes. The first step of setting up Webhook requires…
Recently we were getting the below error on the Omnichannel Ongoing Conversations Dashboard. As the user was having an Omnichannel Administrator role, we expected it to work for the user. We raised a support…
We got the below error while trying to create a quote product programmatically. As the error message specifies, this is because we are trying to add/associate a DRAFT product to the Quote Product. We…
Just sharing the syntax, that we can use to filter the data source based on the status field. Below is our gallery bound to Cases (Data Source) and showing only the Active cases. Items…
11 thoughts on “How to – Use Custom API to create custom messages in Dynamics 365”