TAG LINE
TAG LINE
SMALL TITLE

Event Subscription

(API Version v8)


What can you do with EventSubscription?


Properties

Property Details
identity
READ-ONLY
"identity": 26
Type: Number
This is the unique numeric identifier for the EventSubscription
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
eventRegistrationId
"eventRegistrationId": 22
Type: Number
Unique identifier for the associated EventRegistration object.
eventRegistrationName
"eventRegistrationName": "Sample Name"
Type: String
The name of the object associated with the eventRegistrationId property.
eventBindingActionId
"eventBindingActionId": 3
Type: Number
Unique identifier for the associated EventBindingAction object.
eventBindingActionName
"eventBindingActionName": "Sample Name"
Type: String
The name of the object associated with the eventBindingActionId property.
accessTypeId
"accessTypeId": 18
Type: Number
Unique identifier for the associated AccessType object.
accessTypeName
"accessTypeName": "Sample Name"
Type: String
The name of the object associated with the accessTypeId property.
createdByUserId
"createdByUserId": 0
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
updatedByUserId
"updatedByUserId": 6
Type: Number
Unique identifier for the associated User object.
updatedByUserName
"updatedByUserName": "Sample Name"
Type: String
The name of the object associated with the updatedByUserId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the EventSubscription object.

Standard PATCH objects:

  • eventSubscriptionFilter - create, update, delete
  • webhookConfiguration - create, update, delete

DataFlow PATCH objects:

  • eventSubscription - create, update, delete
  • eventSubscriptionFilter - create, update, delete
  • webhookConfiguration - create, update, delete

End Points

DELETEEventSubscription/Email/{id}
Delete an instance of the EventSubscription object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the EventSubscription object.
Delete an instance of the EventSubscription object.
DELETE EventSubscription/Email/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "eventSubscription"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
DELETEEventSubscription/Webhook/{id}
Delete an instance of the EventSubscription object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the EventSubscription object.
Delete an instance of the EventSubscription object.
DELETE EventSubscription/Webhook/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "eventSubscription"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
PATCHEventSubscription/Email/{id}
Update or Add the EventSubscription object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the EventSubscription object.
Update or Add the EventSubscription object and optionally make changes to any child objects.
PATCH EventSubscription/Email/{id}

{
    "details": {},
    "eventSubscriptions": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 19,
                "eventBindingActionId": 8,
                "accessTypeId": 1,
                "createdByUserId": 5,
                "updatedByUserId": 23
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "eventSubscription",
                "instance": {
                    "identity": 1,
                    "name": "Sample Text Data",
                    "description": "Sample Text Data",
                    "isActive": true,
                    "eventRegistrationId": 25,
                    "eventRegistrationName": "Sample Text Data",
                    "eventBindingActionId": 20,
                    "eventBindingActionName": "Sample Text Data",
                    "accessTypeId": 10,
                    "accessTypeName": "Sample Text Data",
                    "createdByUserId": 9,
                    "createdByUserName": "Sample Text Data",
                    "updatedByUserId": 2,
                    "updatedByUserName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
PATCHEventSubscription/Webhook/{id}
Update or Add the EventSubscription object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the EventSubscription object.
Update or Add the EventSubscription object and optionally make changes to any child objects.
PATCH EventSubscription/Webhook/{id}

{
    "details": {},
    "eventSubscriptions": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 4,
                "eventBindingActionId": 1,
                "accessTypeId": 7,
                "createdByUserId": 21,
                "updatedByUserId": 6
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "eventSubscription",
                "instance": {
                    "identity": 1,
                    "name": "Sample Text Data",
                    "description": "Sample Text Data",
                    "isActive": true,
                    "eventRegistrationId": 4,
                    "eventRegistrationName": "Sample Text Data",
                    "eventBindingActionId": 9,
                    "eventBindingActionName": "Sample Text Data",
                    "accessTypeId": 21,
                    "accessTypeName": "Sample Text Data",
                    "createdByUserId": 25,
                    "createdByUserName": "Sample Text Data",
                    "updatedByUserId": 25,
                    "updatedByUserName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTEventSubscription/Email/
Create a new instance of the EventSubscription object.
Create a new instance of the EventSubscription object.
POST EventSubscription/Email/

{
    "name": "Sample Text Data",
    "description": "Sample Text Data",
    "isActive": true,
    "eventRegistrationId": 8,
    "eventBindingActionId": 7,
    "accessTypeId": 24,
    "createdByUserId": 7,
    "updatedByUserId": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 8,
                "eventRegistrationName": "Sample Text Data",
                "eventBindingActionId": 19,
                "eventBindingActionName": "Sample Text Data",
                "accessTypeId": 18,
                "accessTypeName": "Sample Text Data",
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 15,
                "updatedByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTEventSubscription/Webhook/
Create a new instance of the EventSubscription object.
Create a new instance of the EventSubscription object.
POST EventSubscription/Webhook/

{
    "name": "Sample Text Data",
    "description": "Sample Text Data",
    "isActive": true,
    "eventRegistrationId": 5,
    "eventBindingActionId": 23,
    "accessTypeId": 19,
    "createdByUserId": 6,
    "updatedByUserId": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 10,
                "eventRegistrationName": "Sample Text Data",
                "eventBindingActionId": 3,
                "eventBindingActionName": "Sample Text Data",
                "accessTypeId": 12,
                "accessTypeName": "Sample Text Data",
                "createdByUserId": 3,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 2,
                "updatedByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTEventSubscription/Email/{id}
Update an existing instance of the EventSubscription object.
Update an existing instance of the EventSubscription object.
PUT EventSubscription/Email/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "description": "Sample Text Data",
    "isActive": true,
    "eventRegistrationId": 8,
    "eventBindingActionId": 10,
    "accessTypeId": 2,
    "createdByUserId": 8,
    "updatedByUserId": 0
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 25,
                "eventRegistrationName": "Sample Text Data",
                "eventBindingActionId": 12,
                "eventBindingActionName": "Sample Text Data",
                "accessTypeId": 22,
                "accessTypeName": "Sample Text Data",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 1,
                "updatedByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTEventSubscription/Webhook/{id}
Update an existing instance of the EventSubscription object.
Update an existing instance of the EventSubscription object.
PUT EventSubscription/Webhook/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "description": "Sample Text Data",
    "isActive": true,
    "eventRegistrationId": 23,
    "eventBindingActionId": 24,
    "accessTypeId": 27,
    "createdByUserId": 9,
    "updatedByUserId": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "description": "Sample Text Data",
                "isActive": true,
                "eventRegistrationId": 23,
                "eventRegistrationName": "Sample Text Data",
                "eventBindingActionId": 10,
                "eventBindingActionName": "Sample Text Data",
                "accessTypeId": 12,
                "accessTypeName": "Sample Text Data",
                "createdByUserId": 8,
                "createdByUserName": "Sample Text Data",
                "updatedByUserId": 23,
                "updatedByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}