Messaging Documentation
API Docs
  • Introduction
  • Getting started
    • Transitioning from v2 to v4
  • Message structure
    • Entity messages
      • Message group
      • Action
      • Example messages
    • Configuration messages
      • Message group
      • Action
      • Example messages
    • Financial messages
      • Message group
      • Action
      • Example messages
    • Batch Messages
      • Message group
      • Action
      • Example messages
  • Sample projects
  • Message metrics
  • FAQ
  • SQS - Queues
    • Overview
    • Setting up an SQS message integration
    • SQS queue names
  • SNS - PUB/SUB
    • Overview
    • Setting up an SNS message integration
    • SNS topic names
    • Message attributes
  • 🆕EventBridge
    • Overview
    • Setting up an EventBridge integration
Powered by GitBook
On this page
  • Picklist Sources
  • Picklist Source Created
  • Picklist Source Updated
  • Picklist Source Deleted
  • Picklist Source Values
  • Picklist Source Value Created
  • Picklist Source Value Updated
  • Picklist Source Value Deleted
  • Picklists
  • Picklist Created
  • Picklist Updated
  • Picklist Deleted
  • Picklist Values
  • Picklist Value Added
  • Picklist Hierarchy Updated
  • Picklist Value Removed
  • Picklist Presets
  • Picklist Preset Created
  • Picklist Preset Updated
  • Picklist Preset Deleted
  • Picklist Preset Values
  • Picklist Preset Value Added
  • Picklist Preset Value Removed

Was this helpful?

  1. Message structure
  2. Configuration messages

Example messages

Examples of messages that will be published.

Picklist Sources

Picklist Source Created

{
    "action": "picklist-source-created",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:39:41.543Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:39:41.543Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:39:41.543Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Source Updated

{
    "action": "picklist-source-updated",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:39:41.543Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:39:41.543Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:46:08.417Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Source Deleted

{
    "action": "picklist-source-deleted",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:39:41.543Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:39:41.543Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:46:08.417Z",
    "deletedById": 12345,
    "deletedDate": "2025-02-21T20:21:48.2105751Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Source Values

Picklist Source Value Created

{
    "action": "picklist-source-value-created",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:47:19.68Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:47:19.68Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:47:19.68Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "description": "Picklist Source Value Description",
        "id": 4,
        "value": "Picklist Source Value"
    }
}

Picklist Source Value Updated

{
    "action": "picklist-source-value-updated",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:47:19.68Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:47:19.68Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:47:19.68Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "description": "Picklist Source Value Description",
        "id": 4,
        "value": "Picklist Source Value"
    }
}

Picklist Source Value Deleted

{
    "action": "picklist-source-value-created",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:47:19.68Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:47:19.68Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:47:19.68Z",
    "deletedById": 12345,
    "deletedDate": "2025-02-21T20:21:48.2105751Z",
    "messageGroupId": 102,
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "description": "Picklist Source Value Description",
        "id": 4,
        "value": "Picklist Source Value"
    }
}

Picklists

Picklist Created

{
    "action": "picklist-created",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Updated

{
    "action": "picklist-updated",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Deleted

{
    "action": "picklist-deleted",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "deletedById": 12345,
    "deletedDate": "2025-02-21T20:21:48.2105751Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    }
}

Picklist Values

Picklist Value Added

{
    "action": "picklist-value-added",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:40:29.79Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:40:29.79Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:40:29.747Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "id": 2
    }
}

Picklist Hierarchy Updated

{
    "action": "picklist-hierarchy-updated",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:40:29.79Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:40:29.79Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:40:29.747Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "id": 2
    }
}

Picklist Value Removed

{
    "action": "picklist-value-removed",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:40:29.79Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:40:29.79Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:40:29.747Z",
    "messageGroupId": 102,
    "picklist": {
        "description": "Picklist Description",
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistSource": {
        "description": "Picklist Source Description",
        "id": "f70f55e1-56e5-ee11-8351-065151be1e5f",
        "name": "Picklist Source Name"
    },
    "picklistValue": {
        "id": 2
    }
}

Picklist Presets

Picklist Preset Created

{
    "action": "picklist-preset-created",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "messageGroupId": 102,
    "picklist": {
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistPreset": {
        "description": "Picklist Preset Description",
        "id": "50e02513-1e07-ef11-8352-065151be1e5f",
        "name": "Picklist Preset Name"
    }
}

Picklist Preset Updated

{
    "action": "picklist-preset-updated",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "messageGroupId": 102,
    "picklist": {
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistPreset": {
        "description": "Picklist Preset Description",
        "id": "50e02513-1e07-ef11-8352-065151be1e5f",
        "name": "Picklist Preset Name"
    }
}

Picklist Preset Deleted

{
    "action": "picklist-preset-deleted",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-03-18T18:42:06.683Z",
    "createdById": 1094364,
    "createdDate": "2024-03-18T18:42:06.683Z",
    "deletedById": 1094364,
    "deletedDate": "2024-03-18T18:42:06.683Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-03-18T18:42:06.683Z",
    "messageGroupId": 102,
    "picklist": {
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistPreset": {
        "description": "Picklist Preset Description",
        "id": "50e02513-1e07-ef11-8352-065151be1e5f",
        "name": "Picklist Preset Name"
    }
}

Picklist Preset Values

Picklist Preset Value Added

{
    "action": "picklist-preset-value-added",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-04-30T22:16:26.72Z",
    "createdById": 1094364,
    "createdDate": "2024-04-30T18:18:43.547Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-04-30T18:18:43.547Z",
    "messageGroupId": 102,
    "picklist": {
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistPreset": {
        "description": "Picklist Preset Description",
        "id": "50e02513-1e07-ef11-8352-065151be1e5f",
        "name": "Picklist Preset Name"
    }
    "picklistValue": {
        "id": 9,
        "value": "Picklist Value"
    }
}

Picklist Preset Value Removed

{
    "action": "picklist-preset-value-removed",
    "actionExecutedById": 1094364,
    "actionExecutedDate": "2024-04-30T22:19:10.96Z",
    "createdById": 1094364,
    "createdDate": "2024-04-30T18:18:43.547Z",
    "lastUpdatedById": 1094364,
    "lastUpdatedDate": "2024-04-30T18:18:43.547Z",
    "deletedById": 1094364,
    "deletedDate": "2024-04-30T18:18:43.547Z",
    "messageGroupId": 102,
    "picklist": {
        "id": "7f99d737-57e5-ee11-8351-065151be1e5f",
        "name": "Picklist Name"
    },
    "picklistPreset": {
        "description": "Picklist Preset Description",
        "id": "50e02513-1e07-ef11-8352-065151be1e5f",
        "name": "Picklist Preset Name"
    }
    "picklistValue": {
        "id": 9,
        "value": "Picklist Value"
    }
}
PreviousActionNextFinancial messages

Last updated 1 year ago

Was this helpful?