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..
RECENT POSTS –
CRM Record “Email a Link” feature not working
Originally posted on Rajeev Pentyala – Microsoft power platform blog:
Recently few of our CRM users complained OOB “Email a Link” not working. Reason: Machines default “Email” App was set to “Chrome” Fix: Change…
A failure occurred in CrmSecurity while configuration Mailbox in Dynamics 365
As we know, before we can use a mailbox it has to be approved by either Office 365 Global Administrator or by an Exchange Administrator. When Server Side Synchronization was released only the Dynamics … Continue reading “A failure occurred in CrmSecurity while configuration Mailbox in Dynamics 365”
Search Providers (Preview) in Dynamics 365 Customer Service Hub
The new search provider options in Customer Service Hub allow agents to search for files, documents, or articles outside the current organization. The option can be found at Service Management > Knowledge Base Management … Continue reading “Search Providers (Preview) in Dynamics 365 Customer Service Hub”
Knowledge Search Control improvements in Dynamics 365 Customer Service Hub – 2021 Release Wave 1
Knowledge Search control can be configured now in the new form designer, thus eliminating the need to switch to the legacy form designer. Here we have added the Knowledge search control in one of … Continue reading “Knowledge Search Control improvements in Dynamics 365 Customer Service Hub – 2021 Release Wave 1”
Azure AD Conditional Access and Application Users / Service Principal in Dynamics 365
Through Azure AD Conditional Access, we can define and enforce policies regarding access to its cloud resources. Block access to Dynamics 365 by device platform Block access to Dynamics 365 by location. Users who … Continue reading “Azure AD Conditional Access and Application Users / Service Principal in Dynamics 365”
Failed to process metadata description. We ran into a problem publishing the form. Please try again while publishing the form in Dynamics 365
While trying to publish the case form we got the below error – Error: We ran into a problem publishing the form. Please try again. (SessionID: a000b750-91e2-11eb-9fd2-8fd31814d5b2) Adding/removing components, refreshing the form multiple times, etc. didn’t … Continue reading “Failed to process metadata description. We ran into a problem publishing the form. Please try again while publishing the form in Dynamics 365”
Backup Concepts for Azure Data Lake
Azure Data Lake Storage is designed to enable operational and exploratory analytics through a hyper-scale repository There are two different types of Data Lake Store in Azure (Gen1 and Gen2) available at the current…
Enhanced Personal Settings – 2021 Release Wave 1 in Dynamics 365 Sales
With 2021 Release Wave 1, a dedicated area for personal settings has been added in Dynamics 365 Sales Hub. Before 2021 Release Wave 1 à With 2021 Release Wave 1 à We can see … Continue reading “Enhanced Personal Settings – 2021 Release Wave 1 in Dynamics 365 Sales”
What is your IP?
Originally posted on @ramontebar:
What is the IP address used by your online Dynamics 365 or Microsoft Dataverse environment? If you are connecting from a plugin, a Custom API, a custom workflow activity or…
Loading…
Something went wrong. Please refresh the page and/or try again.
9 thoughts on “Use Custom API to create custom messages in Dynamics 365”