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.

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 –

Optimize Delete operation – Dataverse / Dynamics 365

Recently we had to delete records for one of our entities, and we tried out different combinations of batch sizes and the number of threads with 25000 records as a sample to find the … Continue reading “Optimize Delete operation – Dataverse / Dynamics 365”

by Nishant Rana July 28, 2021

Approvals in Microsoft Teams / Power Automate

Approvals App for Teams was introduced early this year. To see it in action, let us start by first adding the Approval app in Teams. Search for the app. And click on Add. The … Continue reading “Approvals in Microsoft Teams / Power Automate”

by Nishant Rana July 27, 2021

Solved– No function signature for the function with name ‘contains’ matches the specified arguments in Canvas Apps

We were getting the below error while trying to set the Items property of the Gallery control and were using Filters in the formula. “The requested operation is invalid. Server Response: Sectors failed: No … Continue reading “Solved– No function signature for the function with name ‘contains’ matches the specified arguments in Canvas Apps”

by Nishant Rana July 26, 2021

Sample code (C#) for Multi-Table Lookup / Polymorphic Lookup attribute in Dataverse / Dynamics 365

For creating multi-table lookup we already have an XrmToolBox plugin Polymorphic Lookup Creator which we should be using ideally, but in case somebody wants to try it out, the below shared sample code can … Continue reading “Sample code (C#) for Multi-Table Lookup / Polymorphic Lookup attribute in Dataverse / Dynamics 365”

by Nishant Rana July 15, 2021July 15, 2021

Sample AppId / ClientId and RedirectUri for quick prototyping (Dataverse / Dynamics 365)

At times we want to quickly try out few things (PoC) by writing a console application or running an SSIS package etc., there we can use the sample ClientId and RedirectUri provided by Microsoft, … Continue reading “Sample AppId / ClientId and RedirectUri for quick prototyping (Dataverse / Dynamics 365)”

by Nishant Rana July 14, 2021

How to – use HTTP Action to call DataVerse / Dynamics 365 Web API in Power Automate

Let us take a simple example, to see the steps involved. Here we will be manually triggering a flow, getting the token, and calling the WhoAmI request in Microsoft Dataverse / Dynamics 365. This … Continue reading “How to – use HTTP Action to call DataVerse / Dynamics 365 Web API in Power Automate”

by Nishant Rana July 13, 2021

Can we update ‘SYSTEM’ user in Dynamics 365 / Dataverse?

We recently were asked to check the possibility of updating the SYSTEM user specifically the primary email field of it. https://docs.microsoft.com/en-us/power-platform/admin/system-application-users Usually, we use SYSTEM user to specify the plugin’s execution context for business … Continue reading “Can we update ‘SYSTEM’ user in Dynamics 365 / Dataverse?”

by Nishant Rana July 9, 2021

Recently we had a requirement to update the “Negative Currency Format” – Regional Options for all the users. We could not find this option in our favorite plugin – User Settings Utility. So to … Continue reading “Update Personal Options / Personalization Settings using UpdateUserSettingsSystemUser Request – Dynamics 365”

by Nishant Rana July 7, 2021

Loading…

Something went wrong. Please refresh the page and/or try again.