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

Get Rules

Request

Get all rules for the organization

Security
bearerAuth
Query
eventstring
resourcestring
resource_idstring
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/rules?event=string&resource=string&resource_id=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[].​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": [
    { … }
  ]
}

Create Rule

Request

Create a new rule

Security
bearerAuth
Bodyapplication/jsonrequired
workspacestring(uuid)required
connectionstring(uuid)required
eventstringnon-emptyrequired
resourcestringnon-empty
resource_idstring^[A-Za-z0-9._:-]{1,64}$
metadataobjectrequired
metadata.​actionstringnon-emptyrequired
metadata.​idstring
metadata.​namestring
metadata.​valuestring
metadata.​keystring
metadata.​datastring
metadata.​optionstring
metadata.​option_valuestring
metadata.​property name*any or stringadditional property
Any of:
any
hiddenboolean
Default false
activeboolean
Default true
curl -i -X POST \
  https://docs.meshes.dev/_mock/openapi/api/v1/rules \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
    "connection": "05107f3a-70a0-49c6-879b-3a441d6562d4",
    "event": "string",
    "resource": "string",
    "resource_id": "string",
    "metadata": {
      "action": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "key": "string",
      "data": "string",
      "option": "string",
      "option_value": "string",
      "property1": {},
      "property2": {}
    },
    "hidden": false,
    "active": true
  }'

Responses

Default Response

Bodyapplication/json
ruleobjectrequired
rule.​idstring(uuid)required
rule.​connectionstring(uuid)required
rule.​workspacestring(uuid)required
rule.​typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
rule.​resourcestringnon-empty
rule.​resource_idstringnon-empty
rule.​eventstringnon-emptyrequired
rule.​metadataobjectrequired
rule.​metadata.​actionstringnon-emptyrequired
rule.​metadata.​idstring
rule.​metadata.​namestring
rule.​metadata.​valuestring
rule.​metadata.​keystring
rule.​metadata.​datastring
rule.​metadata.​optionstring
rule.​metadata.​option_valuestring
rule.​metadata.​property name*any or stringadditional property
Any of:
any
rule.​activeboolean
Default true
rule.​hiddenboolean
Default false
rule.​created_bystringrequired
rule.​created_atstringrequired
Any of:
string(date-time)
rule.​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "rule": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "connection": "05107f3a-70a0-49c6-879b-3a441d6562d4",
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
    "type": "activecampaign",
    "resource": "string",
    "resource_id": "string",
    "event": "string",
    "metadata": { … },
    "active": true,
    "hidden": false,
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Rule

Request

Get Rule by ID

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

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
connectionstring(uuid)required
workspacestring(uuid)required
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
resourcestringnon-empty
resource_idstringnon-empty
eventstringnon-emptyrequired
metadataobjectrequired
metadata.​actionstringnon-emptyrequired
metadata.​idstring
metadata.​namestring
metadata.​valuestring
metadata.​keystring
metadata.​datastring
metadata.​optionstring
metadata.​option_valuestring
metadata.​property name*any or stringadditional property
Any of:
any
activeboolean
Default true
hiddenboolean
Default false
created_bystringrequired
created_atstringrequired
Any of:
string(date-time)
updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "connection": "05107f3a-70a0-49c6-879b-3a441d6562d4",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "type": "activecampaign",
  "resource": "string",
  "resource_id": "string",
  "event": "string",
  "metadata": {
    "action": "string",
    "id": "string",
    "name": "string",
    "value": "string",
    "key": "string",
    "data": "string",
    "option": "string",
    "option_value": "string",
    "property1": {},
    "property2": {}
  },
  "active": true,
  "hidden": false,
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete Rule

Request

Delete Rule by ID

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

Responses

Default Response

Bodyapplication/json
idstringrequired
connectionstringnon-emptyrequired
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
eventstringnon-emptyrequired
resourcestringnon-empty
resource_idstringnon-empty
Response
application/json
{
  "id": "string",
  "connection": "string",
  "type": "activecampaign",
  "event": "string",
  "resource": "string",
  "resource_id": "string"
}

Workspaces

Workspace related end-points

Operations