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 |
|
|
Bound Entity Logical Name |
Logical name of the entity in case of binding type – Entity and EntityCollection. |
|
Is Function |
|
|
Allowed Custom Processing Step Type |
|
|
Execute Privilege Name |
|
|
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.
Get all details here
https://docs.microsoft.com/en-us/powerapps/developer/data-platform/custom-actions
Hope it helps..
Blog posts on 2021 Release Wave 1 – Dynamics 365
RECENT POSTS –
Format property missing in Date Picker in custom page – Dataverse / PowerApps
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…
Configuration Migration Tool Filter Updates and the Power Apps Portal
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…
Marketing Form and required (mandatory) fields in Lead and Contact – Dynamics 365 Marketing
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…
Sample formula for Associating N:N records and Creating 1:N records in Canvas App (PowerApps / Dataverse)
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…
How duplicate phone numbers for customers (contact/account) are handled in Voice Channel (Dynamics 365 Omnichannel for Customer Service)
Before we delve into different scenarios, few key points, we need to be aware of about Phone Numbers in Voice Channels. Voice Channel considers Contact’s Mobile Phone (mobilephone) and Account’s Phone (telephone1) fields. https://learn.microsoft.com/en-us/dynamics365/customer-service/record-identification-rule…
How to – configure Facebook Webhook Validation with Power Automate Flow (Dataverse / Dynamics 365)
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…
Fixed – Omnichannel authentication failed. Contact your administrator in Omnichannel Ongoing Conversations Dashboard
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…
Dynamics 365 AI code with ChatGPT
Example – “Can you write a canvas app formula with ForAll and Patch for Create” – https://www.screencast.com/t/x5TPWw89tFw
Fixed – The product cannot be added because it is not active while creating Quote Product – Dynamics 365 / Dataverse
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…
How to – Filter data source to get the active records Dataverse / PowerApps
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…
Loading…
Something went wrong. Please refresh the page and/or try again.
Nishant Rana's Weblog 
11 thoughts on “How to – Use Custom API to create custom messages in Dynamics 365”