Journey Builder API Specification

The following table includes the most commonly used REST resources that make up the Interaction Service of the Journey Builder API.

Logical Name HTTP Method Resource
Get Event Definitions GET /eventDefinitions
Get Event Definition GET /eventDefinitions/key:{key} or /eventDefinitions/{id}
Create Event Definition POST /eventDefinitions
Update Event Definition PUT /eventDefinitions/key:{key} or /eventDefinitions/{id}
Delete Event Definition DELETE /eventDefinitions/key:{key} or /eventDefinitions/{id}
Fire Entry Event POST /events
Get Discovery Document GET /rest
Get Journey by ID GET /interactions/{id}
Get Collection of Journeys GET /interactions
Create or Save Journey POST /interactions
Update Journey Version PUT /interactions
Delete Journey by ID DELETE /interactions/{id}
Publish Journey Version Async POST /interactions/publishAsync/{id}?versionNumber={versionNumber}
Get Publish Status GET /interactions/publishStatus/{statusId}
Stop Journey POST /interactions/stop/{id}?versionNumber={versionNumber}
Get Journey Audit Log GET /interactions/{id}/audit/{action} or /interactions/{key}/audit/{action}

Get Started with Journey Builder