Callbacks are communications between ConceptShare and your systems via API that lets your systems know when events happen within ConceptShare.
All ConceptShare events support callbacks however some contain general information while others contain specific event information as well. You can then have those events drive other processes, updates or actions within your own systems as defined by your company’s Systems Integrator.
Callbacks in ConceptShare allow for relatively quick integrations without having to do custom programming. A well designed integration can insure a smooth end to end process for your Creative Operations Workflow.
Setting up Callbacks
To access Callbacks, click the gear wheel in the top right, then click on the Account Callbacks option.
A list of any existing callback will be visible and can be sorted by clicking on any of the column headers.
Click on the New Account Callback button in the top right. The Add Account Callback dialogue box will appear:
Complete the requested information:
- URL: The location where you want the callback to make the request too. This is a URL on a system in your environment where you want to listen for events.
- Method: Select GET - Requests data from a specified resource or POST - Submits data to be processed to a specified resource
- Enabled: Toggle Yes or No. There are times when you want to turn callbacks on and off depending on certain scenarios (i.e. development vs. production callbacks) and this allows that control.
- Retry on Failure: This is an option to determine if, for whatever reason, the callback could not complete (i.e. network issue, connectively, server error, etc.) whether to retry the callback again.
- Number of Retry Attempts: This is to determine the maximum number of attempts to retry a callback before giving up.
- Delay between Retry Attempts: If retries are enabled this will determine how long between retries to wait. This value is given in minutes.
- Events: This is the list of events to listen for. You can select multiple events for a given callback and a request will go out for each instance of the given event. For a listing of each of the events and their description see the table attached to this article. http://conceptshare.com/s/V4-Callback-Documentation.pdf
- Then click Save.
To edit an existing Callback, click the checkbox beside the name and choose Actions and Edit. (Or Delete if you are looking to remove the callback.)
NOTE: For Instance Administrators who have access to their domain's admin panel (typically installations that are deployed On Premise) you can also access callbacks from the admin panel. The documentation for that is very similar but can be accessed here:
How do I know which variables are available for a particular event?
ConceptShare provides a page which will simply log the event data passed to it. By configuring a callback, pointing to this particular page and generating the desired event, you can see in the logs what the response was and which variables are included.
To use this method of testing callbacks you can do the following:
- Create a callback for your desired event and point it to the following URLs (where the domain is your particular ConceptShare domain): Log Callback: http://www.yourdomain.com/system.ashx?f=lp, Echo Callback: http://www.yourdomain.com/system.ashx?f=ep
- Generate the event and check the logs. When the callback is complete determine in the endpoint you used the items will either be logged or echoed back to the caller and you can check the history for the results.
Below is an example of what the response body might look like for a COMMENT_ADDED event:
EVENT_GUID => 393d40fa-2f90-4348-b14c-e7709949ce8e
EVENT_ID => COMMENT_ADDED
COMMENT_ID => 930
ASSET_ID => 2765
PROJECT_ID => 730
COMMENT => Test 3
As you can see from the above response, this particular event contained 6 variables. You can now write the appropriate code to react to such events to generate your required workflow.
You now know how to setup Account Callbacks. This is valuable for creating interactions between your systems and ConceptShare to optimize your Creative Operations Management System.