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

Get Connections

Request

Get all connections for the organization

Security
bearerAuth
curl -i -X GET \
  https://docs.meshes.dev/_mock/openapi/api/v1/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": [
    { … }
  ]
}

Create Connection

Request

Create a New Connection

Security
bearerAuth
Bodyapplication/jsonrequired
workspacestring(uuid)required
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
namestring[ 1 .. 128 ] characters^[a-zA-Z0-9 _-]+$required
metadataobjectrequired

arbitrary connector metadata

metadata.​property name*anyadditional property
hiddenboolean
Default false
curl -i -X POST \
  https://docs.meshes.dev/_mock/openapi/api/v1/connections \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
    "type": "activecampaign",
    "name": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "hidden": false
  }'

Responses

Default Response

Bodyapplication/json
connectionobjectrequired
connection.​idstring(uuid)required
connection.​workspacestring(uuid)required
connection.​typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
connection.​namestringrequired
connection.​metadataobjectrequired
connection.​metadata.​property name*anyadditional property
connection.​action_dataobject
connection.​hiddenboolean
Default false
connection.​created_bystringrequired
connection.​created_atstringrequired
Any of:
string(date-time)
connection.​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "connection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
    "type": "activecampaign",
    "name": "string",
    "metadata": { … },
    "action_data": { … },
    "hidden": false,
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get Connection

Request

Get Connection by ID

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

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
workspacestring(uuid)required
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
namestringrequired
metadataobjectrequired
metadata.​property name*anyadditional property
action_dataobject
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",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "type": "activecampaign",
  "name": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "action_data": {
    "property1": null,
    "property2": null
  },
  "hidden": false,
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update Connection

Request

Update Connection by ID

Security
bearerAuth
Path
connection_idstring(uuid)required
Bodyapplication/jsonrequired
namestring[ 1 .. 128 ] characters^[a-zA-Z0-9 _-]+$required
metadataobjectrequired

arbitrary connector metadata

metadata.​property name*anyadditional property
hiddenboolean
curl -i -X PUT \
  'https://docs.meshes.dev/_mock/openapi/api/v1/connections/{connection_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "hidden": true
  }'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
workspacestring(uuid)required
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
namestringrequired
metadataobjectrequired
metadata.​property name*anyadditional property
action_dataobject
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",
  "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  "type": "activecampaign",
  "name": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "action_data": {
    "property1": null,
    "property2": null
  },
  "hidden": false,
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete Connection

Request

Delete Connection by ID

Security
bearerAuth
Path
connection_idstring(uuid)required
Bodyapplication/json
force_deleteboolean
curl -i -X DELETE \
  'https://docs.meshes.dev/_mock/openapi/api/v1/connections/{connection_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "force_delete": true
  }'

Responses

Default Response

Bodyapplication/json
idstringrequired
typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
Response
application/json
{
  "id": "string",
  "type": "activecampaign"
}

Get Connection Actions

Request

Get Connection Actions by ID

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

Responses

Default Response

Bodyapplication/json
any
Response
application/json
null

Get Connection Fields

Request

Get Connection Fields by Connection ID

Security
bearerAuth
Path
connection_idstring(uuid)required
Query
refreshstring or boolean
Any of:
string
Enum"true""false"
curl -i -X GET \
  'https://docs.meshes.dev/_mock/openapi/api/v1/connections/{connection_id}/fields?refresh=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Default Response

Bodyapplication/json
idstring(uuid)required
workspace_idstring(uuid)required
connection_idstring(uuid)required
integration_typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
catalog_versionstring[ 1 .. 512 ] charactersrequired

Catalog version (e.g. hash of normalized schema)

refreshed_atstringrequired
Any of:
string(date-time)
created_bystringnon-emptyrequired
created_atstringrequired
Any of:
string(date-time)
updated_atstringrequired
Any of:
string(date-time)
fieldsArray of objectsrequired
fields[].​keystringnon-emptyrequired
fields[].​labelstringnon-empty
fields[].​typestringrequired
Enum"string""number""boolean""date""datetime""enum""multi_enum""json""object""array"
fields[].​descriptionstringnon-empty
fields[].​constraintsobject
fields[].​provider_metaobject
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
  "integration_type": "activecampaign",
  "catalog_version": "string",
  "refreshed_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "fields": [
    { … }
  ]
}

Get Connection Default Mappings

Request

Get Connection Default Mappings by Connection ID

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

Responses

Default Response

Bodyapplication/json
statusstringrequired
Enum"stored""generated"
mappingobjectrequired
mapping.​idstring(uuid)required
mapping.​mapping_idstring(uuid)required
mapping.​versioninteger> 0required
mapping.​workspace_idstring(uuid)required
mapping.​connection_idstring(uuid)required
mapping.​integration_typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
mapping.​namestring[ 1 .. 64 ] charactersrequired
mapping.​schemaobjectrequired
mapping.​schema.​schema_versionnumberrequired
Value1
mapping.​schema.​fieldsArray of objects<= 250 itemsrequired
mapping.​schema.​fields[].​deststring[ 1 .. 128 ] charactersrequired
mapping.​schema.​fields[].​sourceobjectrequired
Any of:
mapping.​schema.​fields[].​source.​typestringrequired
Value"literal"
mapping.​schema.​fields[].​source.​valuestring or number or boolean or (any or null)required
Any of:
[ 1 .. 256 ] characters
string[ 1 .. 256 ] characters
mapping.​schema.​fields[].​transformsArray of objects<= 10 items
mapping.​schema.​fields[].​on_errorstring
Enum"skip_field""warn_action""fail_action"
mapping.​schema.​fields[].​notesstring[ 1 .. 1024 ] characters
mapping.​schema.​metaobject
mapping.​catalog_versionstring[ 1 .. 512 ] characters

Catalog version (e.g. hash of normalized schema)

mapping.​created_bystringnon-empty
mapping.​created_atstringrequired
Any of:
string(date-time)
mapping.​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "status": "stored",
  "mapping": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "mapping_id": "9fd90e5f-616a-481f-87a6-42d72ba405e7",
    "version": 0,
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
    "integration_type": "activecampaign",
    "name": "string",
    "schema": { … },
    "catalog_version": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update Connection Default Mappings

Request

Update Connection Default Mappings by Connection ID

Security
bearerAuth
Path
connection_idstring(uuid)required
Bodyapplication/jsonrequired
workspace_idstring(uuid)
mapping_idstring(uuid)
expected_versioninteger> 0
namestring[ 1 .. 64 ] characters
schemaobjectrequired
schema.​schema_versionnumberrequired
Value1
schema.​fieldsArray of objects<= 250 itemsrequired
schema.​fields[].​deststring[ 1 .. 128 ] charactersrequired
schema.​fields[].​sourceobjectrequired
Any of:
schema.​fields[].​source.​typestringrequired
Value"literal"
schema.​fields[].​source.​valuestring or number or boolean or (any or null)required
Any of:
[ 1 .. 256 ] characters
string[ 1 .. 256 ] characters
schema.​fields[].​transformsArray of objects<= 10 items
schema.​fields[].​on_errorstring
Enum"skip_field""warn_action""fail_action"
schema.​fields[].​notesstring[ 1 .. 1024 ] characters
schema.​metaobject
curl -i -X PUT \
  'https://docs.meshes.dev/_mock/openapi/api/v1/connections/{connection_id}/mappings/default' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "mapping_id": "9fd90e5f-616a-481f-87a6-42d72ba405e7",
    "expected_version": 0,
    "name": "string",
    "schema": {
      "schema_version": 1,
      "fields": [
        {
          "dest": "string",
          "source": {
            "type": "literal",
            "value": "string"
          },
          "transforms": [
            {
              "type": "to_string"
            }
          ],
          "on_error": "skip_field",
          "notes": "string"
        }
      ],
      "meta": {
        "name": "string",
        "notes": "string"
      }
    }
  }'

Responses

Default Response

Bodyapplication/json
statusstringrequired
Enum"stored""generated"
mappingobjectrequired
mapping.​idstring(uuid)required
mapping.​mapping_idstring(uuid)required
mapping.​versioninteger> 0required
mapping.​workspace_idstring(uuid)required
mapping.​connection_idstring(uuid)required
mapping.​integration_typestringrequired
Enum"activecampaign""aweber""hubspot""intercom""mailchimp""mailerlite""resend""salesforce""slack""webhook"
mapping.​namestring[ 1 .. 64 ] charactersrequired
mapping.​schemaobjectrequired
mapping.​schema.​schema_versionnumberrequired
Value1
mapping.​schema.​fieldsArray of objects<= 250 itemsrequired
mapping.​schema.​fields[].​deststring[ 1 .. 128 ] charactersrequired
mapping.​schema.​fields[].​sourceobjectrequired
Any of:
mapping.​schema.​fields[].​source.​typestringrequired
Value"literal"
mapping.​schema.​fields[].​source.​valuestring or number or boolean or (any or null)required
Any of:
[ 1 .. 256 ] characters
string[ 1 .. 256 ] characters
mapping.​schema.​fields[].​transformsArray of objects<= 10 items
mapping.​schema.​fields[].​on_errorstring
Enum"skip_field""warn_action""fail_action"
mapping.​schema.​fields[].​notesstring[ 1 .. 1024 ] characters
mapping.​schema.​metaobject
mapping.​catalog_versionstring[ 1 .. 512 ] characters

Catalog version (e.g. hash of normalized schema)

mapping.​created_bystringnon-empty
mapping.​created_atstringrequired
Any of:
string(date-time)
mapping.​updated_atstringrequired
Any of:
string(date-time)
Response
application/json
{
  "status": "stored",
  "mapping": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "mapping_id": "9fd90e5f-616a-481f-87a6-42d72ba405e7",
    "version": 0,
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
    "integration_type": "activecampaign",
    "name": "string",
    "schema": { … },
    "catalog_version": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Events

Event related end-points

Operations

Integrations

Integration related end-points

Operations

Rules

Rule related end-points

Operations

Workspaces

Workspace related end-points

Operations