Subscriptions provide webhook functionality that allows the notification of external services about specific events in BlueDolphin via HTTP requests. Subscriptions can be configured with a URL endpoint, specific BlueDolphin events to listen for, headers for authentication, and HTTP verb settings
The current subscription functionality uses a “fire and forget” approach. The service will attempt 3 times to send the message payload to the external URL provided.
Examples of payloads sent to the external URL provided:
For the ObjectUpdated
event:
{
"boemsChanged": <boolean>,
"propertiesChanged": <boolean>,
"titleChanged": <boolean>,
"tenant": "<tenant>",
"objectId": "000040918752f02800010000",
"title": "<object_title>",
"eventType": "ObjectUpdated",
"objectDefinitionId": "0000c4f00c0ba6f25c010000",
"workspaceId": "0000a42db423a172f43a0000",
"objectLifecycleState": 0
}
For both the ObjectArchived
and ObjectCreated
events:
{
"tenant": "<tenant>",
"objectId": "000040918752f02800010000",
"title": "<object_title>",
"eventType": "<ObjectCreated|ObjectArchived>",
"objectDefinitionId": "0000c4f00c0ba6f25c010000",
"workspaceId": "0000a42db423a172f43a0000",
"objectLifecycleState": 0
}