Skip to content

Meshes API (1.0.0)

Meshes API for event ingestion, connections, rules, and workspace management.

Main Meshes documentation can be found here
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.meshes.dev/_mock/openapi
https://api.meshes.io

Connections

Connection related end-points

Operations

Events

Event related end-points

Operations

Get Events

Request

Get all events for the organization

Security
bearerAuth
Query
limitinteger[ 1 .. 200 ]
Default 50
cursorstring or null^[A-Za-z0-9_-]+$
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/events?limit=50&cursor=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Default Response

Bodyapplication/json
countinteger>= 0required
limitinteger> 0required
next_cursorstring or null
recordsArray of objectsrequired
records[].​idstring(uuid)required
records[].​typestring
Default "event"
Value"event"
records[].​workspacestring(uuid)required
records[].​eventstringrequired
records[].​resourcestringnon-empty
records[].​resource_idstringnon-empty
records[].​statusstringrequired
Enum"pending""processing""completed""failed"
records[].​total_rulesinteger>= 0
Default 0
records[].​completed_countinteger>= 0
Default 0
records[].​failed_countinteger>= 0
Default 0
records[].​started_atstring
Any of:
string(date-time)
records[].​completed_atstring
Any of:
string(date-time)
records[].​created_bystringrequired
records[].​created_atstringrequired
Any of:
string(date-time)
records[].​rule_eventsArray of objects
Response
application/json
{
  "count": 0,
  "limit": 0,
  "next_cursor": "string",
  "records": [
    { … }
  ]
}

Create Event

Request

Create (emit) a single event

Security
bearerAuth or publishableKey
Bodyapplication/jsonrequired
eventstringnon-emptyrequired
payloadobjectrequired
payload.​emailstring(email)non-empty
payload.​idstring
payload.​ip_addressstring
payload.​namestring
payload.​first_namestring
payload.​last_namestring
payload.​phonestring
payload.​resource_urlstring
payload.​property name*anyadditional property
resourcestringnon-empty
resource_idstringnon-empty
typestring
Default "event"
Value"event"
workspacestring(uuid)
curl -i -X POST \
  https://docs.meshes.dev/_mock/openapi/api/v1/events \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": "string",
    "payload": {
      "email": "[email protected]",
      "id": "string",
      "ip_address": "string",
      "name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "resource_url": "string",
      "property1": null,
      "property2": null
    },
    "resource": "string",
    "resource_id": "string",
    "type": "event",
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
  }'

Responses

Default Response

Bodyapplication/json
eventobjectrequired
event.​idstring(uuid)required
event.​eventstringnon-emptyrequired
event.​resourcestringnon-empty
event.​resource_idstringnon-empty
event.​typestring
Default "event"
Value"event"
event.​workspacestring(uuid)required
event.​created_bystringrequired
event.​created_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "event": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "event": "string",
    "resource": "string",
    "resource_id": "string",
    "type": "event",
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Create Bulk Events

Request

Create (emit) multiple events up to 100 at a time

Security
bearerAuth or publishableKey
Bodyapplication/jsonArray [
eventstringnon-emptyrequired
payloadobjectrequired
payload.​emailstring(email)non-empty
payload.​idstring
payload.​ip_addressstring
payload.​namestring
payload.​first_namestring
payload.​last_namestring
payload.​phonestring
payload.​resource_urlstring
payload.​property name*anyadditional property
resourcestringnon-empty
resource_idstringnon-empty
typestring
Default "event"
Value"event"
workspacestring(uuid)
]
curl -i -X POST \
  https://docs.meshes.dev/_mock/openapi/api/v1/events/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "event": "string",
      "payload": {
        "email": "[email protected]",
        "id": "string",
        "ip_address": "string",
        "name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "resource_url": "string",
        "property1": null,
        "property2": null
      },
      "resource": "string",
      "resource_id": "string",
      "type": "event",
      "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89"
    }
  ]'

Responses

Default Response

Bodyapplication/json
countinteger>= 0required
error_countinteger>= 0
recordsArray of objectsrequired
Any of:
records[].​idstring(uuid)required
records[].​eventstringnon-emptyrequired
records[].​resourcestringnon-empty
records[].​resource_idstringnon-empty
records[].​typestring
Default "event"
Value"event"
records[].​workspacestring(uuid)required
records[].​created_bystringrequired
records[].​created_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "count": 0,
  "error_count": 0,
  "records": [
    { … }
  ]
}

Get Event

Request

Get Event by ID

Security
bearerAuth
Path
event_idstring(uuid)required
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/events/{event_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
typestring
Default "event"
Value"event"
workspacestring(uuid)required
eventstringrequired
resourcestringnon-empty
resource_idstringnon-empty
statusstringrequired
Enum"pending""processing""completed""failed"
total_rulesinteger>= 0
Default 0
completed_countinteger>= 0
Default 0
failed_countinteger>= 0
Default 0
started_atstring
Any of:
string(date-time)
completed_atstring
Any of:
string(date-time)
created_bystringrequired
created_atstringrequired
Any of:
string(date-time)
rule_eventsArray of objects
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "event",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "event": "string",
  "resource": "string",
  "resource_id": "string",
  "status": "pending",
  "total_rules": 0,
  "completed_count": 0,
  "failed_count": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "rule_events": [
    { … }
  ]
}

Get Event with Payload

Request

Get Event by ID and include the payload

Security
bearerAuth
Path
event_idstring(uuid)required
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/events/{event_id}/payload' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
typestring
Default "event"
Value"event"
workspacestring(uuid)required
eventstringrequired
resourcestringnon-empty
resource_idstringnon-empty
statusstringrequired
Enum"pending""processing""completed""failed"
total_rulesinteger>= 0
Default 0
completed_countinteger>= 0
Default 0
failed_countinteger>= 0
Default 0
started_atstring
Any of:
string(date-time)
completed_atstring
Any of:
string(date-time)
created_bystringrequired
created_atstringrequired
Any of:
string(date-time)
rule_eventsArray of objects
payloadobjectrequired
payload.​emailstring(email)non-empty
payload.​idstring
payload.​ip_addressstring
payload.​namestring
payload.​first_namestring
payload.​last_namestring
payload.​phonestring
payload.​resource_urlstring
payload.​property name*anyadditional property
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "event",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "event": "string",
  "resource": "string",
  "resource_id": "string",
  "status": "pending",
  "total_rules": 0,
  "completed_count": 0,
  "failed_count": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "rule_events": [
    { … }
  ],
  "payload": {
    "email": "[email protected]",
    "id": "string",
    "ip_address": "string",
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "resource_url": "string",
    "property1": null,
    "property2": null
  }
}

Retry Event

Request

Retry a single event rule

Security
bearerAuth
Path
event_idstring(uuid)required
rule_idstring(uuid)required
curl -i -X POST \
  'https://docs.meshes.dev/_mock/openapi/api/v1/events/{event_id}/rules/{rule_id}/retry' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
typestringrequired
Value"rule"
workspacestring(uuid)required
eventstringrequired
event_idstring(uuid)required
resourcestringnon-empty
resource_idstringnon-empty
connectionstring(uuid)required
rulestring(uuid)required
integration_typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
statusstringrequired
Enum"pending""processing""completed""failed"
attempt_countinteger>= 0required
started_atstring
Any of:
string(date-time)
completed_atstring
Any of:
string(date-time)
last_errorstring
created_bystringrequired
created_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "rule",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "event": "string",
  "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  "resource": "string",
  "resource_id": "string",
  "connection": "05107f3a-70a0-49c6-879b-3a441d6562d4",
  "rule": "472a7969-d690-4aff-955f-38ab8ac65ab2",
  "integration_type": "activecampaign",
  "status": "pending",
  "attempt_count": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "last_error": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Integrations

Integration related end-points

Operations

Rules

Rule related end-points

Operations

Workspaces

Workspace related end-points

Operations