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 –
SQL4CDS UTC Mode: Converting Advanced Find Date Filters to UTC Boundaries– A Quick Reference (Dataverse / Dynamics 365)
While validating record counts for a Work Orders view in Dynamics 365 Field Service, we ran into the same underlying issue covered in an earlier post – Why SQL4CDS Record Counts May Not Match…
Hide Expired Sessions in Event Registration Form using JavaScript (Dynamics 365 Customer Insights – Journeys)
One of our recent requirements was to ensure that users could no longer register for event sessions once the session had already ended. The goal was to improve the user experience by hiding expired…
When Entity.Id Is Guid.Empty with QueryExpression.Distinct = True (Dataverse)
While optimising the performance of a Dataverse plugin, we noticed a QueryExpression using ColumnSet(true). The business logic only required a few attributes, so replacing ColumnSet(true) with a minimal ColumnSet looked like an easy performance…
Implementing Cloudflare Turnstile for Dynamics 365 Customer Insights – Journeys Real-Time Marketing Forms
Check the previous posts for more details – In one of our recent projects, we implemented Cloudflare Turnstile (Invisible) for a Dynamics 365 Customer Insights – Journeys Real-Time Marketing form. In this post, we’ll…
Custom Form Submission Validation in Dynamics 365 Customer Insights – Journeys: Inside the Validation Pipeline and the “ms_captcha_solution” Error
While implementing custom form submission validation (server side validation) for Dynamics 365 Customer Insights – Journeys Real-Time Marketing forms, we came across the following error, “Required params cannot be null or empty -ms_captcha_solutionms_captcha_typems_captcha_flow_id” after…
Implementing Server-Side Honeypot Validation for Dynamics 365 Customer Insights – Journeys Forms
In our previous post, we implemented a simple Honeypot for Dynamics 365 Customer Insights – Journeys Real-Time Marketing forms using JavaScript. Although that prevents most automated submissions, the validation only runs in the browser.…
Implementing a Simple Honeypot in Dynamics 365 Customer Insights – Journeys Real-time Marketing Forms
While working with Dynamics 365 Customer Insights – Journeys Real-time Marketing Forms, we wanted to explore a simple way of reducing bot submissions. A common technique used on websites is a honeypot. The idea…
Retrieve All One-to-Many Relationships and Cascade Delete Behavior for a Dataverse Table Using C#
While working on a Dynamics 365 Field Service cleanup, we needed to delete a large number of Work Order records. Before doing so, we wanted to understand exactly what would happen to the related…
Why SQL4CDS Record Counts May Not Match Advanced Find for Date Filters (Dataverse / Dynamics 365)
While validating some Dynamics 365 Field Service data recently, we came across an interesting scenario where SQL4CDS and Advanced Find returned different record counts even though the date filters appeared to be identical. At…
How We Successfully Removed the Resco Woodford Managed Solution from Dynamics 365 Field Service
Recently, we needed to remove the legacy Resco MobileCRM (Woodford) managed solution from a Dynamics 365 Field Service environment. Although the uninstall initially appeared straightforward, when we attempted to uninstall the Woodford solution, Dynamics…
Something went wrong. Please refresh the page and/or try again.
Discover more from Nishant Rana's Weblog
Subscribe to get the latest posts sent to your email.
Share It -
Nishant Rana's Weblog 
11 thoughts on “How to – Use Custom API to create custom messages in Dynamics 365”