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

Integrations

Integration related end-points

Operations

Rules

Rule related end-points

Operations

Workspaces

Workspace related end-points

Operations

Get Workspaces

Request

Get all workspaces for the organization

Security
bearerAuth
curl -i -X GET \
  https://docs.meshes.dev/_mock/openapi/api/v1/workspaces \
  -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[].​namestringrequired
records[].​descriptionstring or nullrequired
records[].​created_atstring(date-time)required
records[].​updated_atstring(date-time)required
Response
application/json
{
  "count": 0,
  "limit": 0,
  "next_cursor": "string",
  "records": [
    { … }
  ]
}

Create Workspace

Request

Create a New Workspace

Security
bearerAuth
Bodyapplication/jsonrequired
namestring[ 3 .. 50 ] characters^[a-zA-Z0-9 _-]+$required
descriptionstring<= 1024 characters
curl -i -X POST \
  https://docs.meshes.dev/_mock/openapi/api/v1/workspaces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

Default Response

Bodyapplication/json
workspaceobjectrequired
workspace.​idstring(uuid)required
workspace.​namestringrequired
workspace.​descriptionstring or nullrequired
workspace.​created_atstring(date-time)required
workspace.​updated_atstring(date-time)required
Response
application/json
{
  "workspace": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Workspace

Request

Get Workspace by ID

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

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
namestringrequired
descriptionstring or nullrequired
created_atstring(date-time)required
updated_atstring(date-time)required
publishable_keyobjectrequired
publishable_key.​public_keystringnon-emptyrequired
publishable_key.​namestringnon-emptyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "publishable_key": {
    "public_key": "string",
    "name": "string"
  }
}

Update Workspace

Request

Update Workspace by ID

Security
bearerAuth
Path
workspace_idstring(uuid)required
Bodyapplication/jsonrequired
namestring[ 3 .. 50 ] characters^[a-zA-Z0-9 _-]+$required
descriptionstring or null<= 1024 characters
curl -i -X PUT \
  'https://docs.meshes.dev/_mock/openapi/api/v1/workspaces/{workspace_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
namestringrequired
descriptionstring or nullrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get Workspace Connections

Request

Get all connections for the workspace

Security
bearerAuth
Path
workspace_idstring(uuid)required
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/workspaces/{workspace_id}/connections' \
  -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[].​workspacestring(uuid)required
records[].​typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
records[].​namestringrequired
records[].​metadataobjectrequired
records[].​metadata.​property name*anyadditional property
records[].​action_dataobject
records[].​hiddenboolean
Default false
records[].​created_bystringrequired
records[].​created_atstringrequired
Any of:
string(date-time)
records[].​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "count": 0,
  "limit": 0,
  "next_cursor": "string",
  "records": [
    { … }
  ]
}

Get Workspace Rules

Request

Get all rules for the workspace

Security
bearerAuth
Path
workspace_idstring(uuid)required
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/workspaces/{workspace_id}/rules' \
  -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[].​connectionstring(uuid)required
records[].​workspacestring(uuid)required
records[].​typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
records[].​resourcestringnon-empty
records[].​resource_idstringnon-empty
records[].​eventstringnon-emptyrequired
records[].​metadataobjectrequired
records[].​metadata.​actionstringnon-emptyrequired
records[].​metadata.​idstring
records[].​metadata.​namestring
records[].​metadata.​valuestring
records[].​metadata.​keystring
records[].​metadata.​datastring
records[].​metadata.​optionstring
records[].​metadata.​option_valuestring
records[].​metadata.​property name*any or stringadditional property
Any of:
any
records[].​activeboolean
Default true
records[].​hiddenboolean
Default false
records[].​created_bystringrequired
records[].​created_atstringrequired
Any of:
string(date-time)
records[].​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "count": 0,
  "limit": 0,
  "next_cursor": "string",
  "records": [
    { … }
  ]
}

Get Workspace Events

Request

Get all events for the workspace

Security
bearerAuth
Path
workspace_idstring(uuid)required
Query
limitinteger[ 1 .. 200 ]
Default 50
cursorstring or null^[A-Za-z0-9_-]+$
eventstring
resourcestring
resource_idstring
statusstring
Enum"pending""processing""completed""failed"
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/workspaces/{workspace_id}/events?limit=50&cursor=string&event=string&resource=string&resource_id=string&status=pending' \
  -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": [
    { … }
  ]
}