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 –
Workstreams Overview – part 2 – Dynamics 365 Customer Service / Omnichannel
Continuing the previous post, let us now delve deeper into the different options inside each of the workstream types. Let us first create a workstream of type Messaging – Chat (Persistent) with work distribution … Continue reading “Workstreams Overview – part 2 – Dynamics 365 Customer Service / Omnichannel”
Workstreams Overview – part 1 – Dynamics 365 Customer Service / Omnichannel
Workstreams can be defined as records or settings, where we can set up the channel, and define routing rules, work distribution, and bots to route work items to the appropriate queue/agents. Workstream can be … Continue reading “Workstreams Overview – part 1 – Dynamics 365 Customer Service / Omnichannel”
How to – Provision / Setup Omnichannel for Customer Service trial – Dynamics 365
In this post, we’d start by creating a trial of Dynamics 365 CustomerService. Navigate to – https://dynamics.microsoft.com/en-us/customer-service/overview/ And select Try for free Enter your email details and follow the steps. In a few mins, … Continue reading “How to – Provision / Setup Omnichannel for Customer Service trial – Dynamics 365”
How to – Connect to Exchange Online to get mailbox details (PowerShell)
Recently we were trying to figure out a few details about the user’s mailbox. To get the details – Open Windows PowerShell with the “Run as Administrator” option. Install the Exchange Online Module – … Continue reading “How to – Connect to Exchange Online to get mailbox details (PowerShell)”
{Hidden Gem}Understanding Server Side sync Performance Dashboard
Originally posted on MSDYNAMICSBLOG BY DEEPESH:
In my previous post, I shared Step by Step guide to configure Server side sync: {Step by Step} Set up server side sync with CRM 2015 Update 1…
Improve fetch xml performance by using latematerialize option.
Originally posted on Passion Dynamics:
If you have been working on dynamics projects, I bet fetch xml is your best friend as it’s really an easiest way to query and execute in order to…
How to – Clone a record in Dataverse / Dynamics 365 (C#)
Here we will be cloning the below contact record – For it, we can make use Clone method of EntityExtensions class If we run the below code, we will get the “Cannot insert duplicate … Continue reading “How to – Clone a record in Dataverse / Dynamics 365 (C#)”
How to –Upload files to File Column / Attribute in SSIS from Azure Blog Storage – KingswaySoft (Dynamics 365 / CRM)
Below are a few ways we can upload files to the File Column type field using KingswaySoft’ s Integration Toolkit and Premium Flat File Source and Premium Derived column which are part of the … Continue reading “How to –Upload files to File Column / Attribute in SSIS from Azure Blog Storage – KingswaySoft (Dynamics 365 / CRM)”
Environment Variable referencing Azure Key Vault secrets (Dataverse / Power Platform)
Check out the below articles – https://docs.microsoft.com/en-us/power-apps/maker/data-platform/environmentvariables#use-azure-key-vault-secrets-preview Within plugin – https://itmustbecode.com/azure-key-vault-secrets-in-dataverse/ Within Power Automate – https://www.msautomate.com/2022/06/16/azure-keyvault-and-power-automate/ https://powerapps.microsoft.com/en-us/blog/how-to-use-environment-variables-with-akv-secrets-in-the-ci-cd-pipeline-when-deploying-applications/ https://blog.yannickreekmans.be/environment-variable-secrets-azure-key-vault-improvement/
Enable/Disable Affinity Cookie on Azure Function App
Originally posted on Meghna Kharera's Blog:
Affinity cookie is used to control the effective loading of the website and to ensure that all user requests are directed to the same server in any browsing…
Loading…
Something went wrong. Please refresh the page and/or try again.
Share this:
Nishant Rana's Weblog 
11 thoughts on “How to – Use Custom API to create custom messages in Dynamics 365”