Field reference
Your endpoint receives these events through a subscription in Data streams in Nexus, under the event types below. Unless the subscription transforms the payload, the request body is the payload the schemas describe, with no envelope around it.
In the payload, the Inbound API block is called a trigger.
triggerId is the block’s id, and the last segment of its url.
- Every event carries the block’s whole state after the change. You never combine events to know what a block looks like.
- A save that changes nothing publishes nothing. Dates are compared to the second.
- One save can publish two events. A save that changes the details and publishes or stops the block publishes Trigger Updated first. Creating a published block publishes Trigger Created, then Trigger Published. Both events share the time of the change, and their
eventIdvalues differ in the event name. - A pasted copy is unpublished, so copying a block publishes Trigger Created alone.
- Who made the change, and when, is named after the change. Trigger Updated carries
updatedByandupdatedAt, Trigger Published carriespublishedByandpublishedAt, and so on.createdByandcreatedAtare on every event. - Whether the block is active is not sent. The block accepts calls while
isPublishedistrueand the current time is betweenstartDateandendDate. Work it out on your side. - Deleting a campaign publishes no events. Nexus lets an admin user delete a campaign only once its blocks are gone, and each block deletion publishes Trigger Deleted.
- A block last saved before Lobyco released these events publishes nothing until its next save.
- Property names are camelCase, such as
triggerIdandeventId. - A property with no value is left out of the payload, not sent as
null. Onlydescription,url,startDateandendDatecan be absent. - Dates are UTC with second precision, in the form
yyyy-MM-ddTHH:mm:ssZ. The time insideeventIdis the exception. It is written to the tick, asyyyy-MM-ddTHH:mm:ss.fffffff, so two saves within one second still get different ids.
Schemas
- Trigger Created
- Trigger Updated
- Trigger Published
- Trigger Stopped
- Trigger Deleted
Related
- InboundAPI integration — how your system calls the URL these events carry.
- Campaign events — the campaigns the Inbound API blocks belong to.
- Block reference — what an admin user configures on the Inbound API block.