MailcrateDocs
Journey hooks

Trigger a journey by webhook

POST
/hooks/journeys/{token}

Enrolls a contact into the journey that owns the trigger URL. Needs no API key: the token in the path is the credential, and calls are rate limited per IP address. Copy the URL from the journey's webhook trigger in the app.

Path Parameters

token*string

Request Body

application/json
  1. body
email?string
Formatemail
contactId?string
Formatuuid
externalIdentifier?string
properties?

Response Body

Example Request
curl -X POST 'https://api.mailcrate.io/hooks/journeys/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Update an inbound address PUT

Requires the `inbound:write` scope.

Enroll a contact POST

Requires the `journey:write` scope.