The Romify REST API enables seamless integration with the Romify platform, allowing external systems to connect, retrieve, and manage event and lead data captured through Romify. Designed for flexibility and efficiency, this API facilitates data exchange via HTTPS endpoints and can trigger webhooks for real-time updates, ensuring that your connected systems remain synchronized with the latest events and lead interactions on Romify.
Romify Rest API uses Bearer Token Authorization header parameter on the POST requests
Authorization: Bearer <your token>
X-Refresh-Token is optional. It will automatically refresh your token, if it has expired.
The easiest way to test that your token is valid is to call the version endpoint.
curl -X POST <https://hub.romify.io/api/v1/version> \\
-H "Authorization: Bearer <your token>" \\
-H "X-Refresh-Token: <your refresh token>"
-H "Content-Type: application/json"
parameter | value | example |
---|---|---|
n/a | n/a | No parameters needed |
curl -X POST <https://hub.romify.io/api/v1/version> \\
-H "Authorization: Bearer <your token>" \\
-H "Content-Type: application/json"
Returns: APIv1Version
parameter | required | value | example |
---|---|---|---|
flowIdentifier | optional | The Romify flow identifier for the examples. If omitted, an example is given for all available flows. | example_flow_abc |
NOTE: Returns randomized example leads for each of the Flow configurations set up in the Romify Hub.
curl -X POST <https://hub.romify.io/api/v1/[exampleleads](https://hub.romify.io/api/v1/exampleleads)> \\
-H "Authorization: Bearer <your token>" \\
-H "Content-Type: application/json" \\
-d '{"flowIdentifier": "universal_lead_capture_bqy"}'
Returns: APIv1Lead[]
parameter | required | value | example |
---|---|---|---|
eventId | optional | Romify Event ID. If not present, returns leads from all events from given period (dates ate required). | vf92d2f6-3a0b-49c6-bef4-921eaf3bbeda |
fromDate | optional | ISO Date string. If not present, eventId must be included. | 2024-09-20T20:05:13.483Z |
toDate | optional | ISO Date string. If not present, eventId must be included. If present, fromDate must be included. | 2024-09-30T20:05:13.485Z |
limit | optional | Max number of leads returned. Defaults to 2000. | 100 |
curl -X POST <https://hub.romify.io/api/v1/leads> \\
-H "Authorization: Bearer <your token>" \\
-H "Content-Type: application/json" \\
-d '{
"eventId": "vf92d2f6-3a0b-49c6-bef4-921eaf3bbeda",
"fromDate": "2024-09-20T20:05:13.483Z",
"toDate": "2024-09-30T20:05:13.485Z",
"limit": 1000
}'