Skip to main content
POST
/
pipelines
cURL
curl --request POST \
  --url https://app.indexing.co/dw/pipelines \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "transformation": "<string>",
  "filter": "<string>",
  "filterKeys": [
    "<string>"
  ],
  "networks": [
    "<string>"
  ],
  "enabled": true,
  "delivery": {
    "adapter": "<string>",
    "connection": "<string>",
    "connectionUri": "<string>",
    "table": "<string>",
    "uniqueKeys": [
      "<string>"
    ]
  }
}'
{
  "message": "<string>"
}

​
Destinations

There are currently three flavors of destinations available via self-service APIs: Webhooks, WebSockets, and Postgres. There are 16 total that are currently supported by Indexing Co generally though - reach out if you need something else!

​
Webhooks

Here’s an example payload for creating a pipeline that delivers to a webhook: 
{
  ...
  "delivery": {
    "adapter": "HTTP",
    "connection": {
      "host": "https://webhook.site/...",
      "headers": {
        "some-auth-key": "some-auth-key"
      }
    }
  },
  ...
}

​
WebSockets

Here’s an example payload for creating a pipeline that delivers to a websocket: 
{
  ...
  "delivery": {
    "adapter": "WEBSOCKET",
    "connection": {
      "host": "ws://websocket-host.com/...",
      "headers": {
        "some-auth-key": "some-auth-key"
      }
    }
  },
  ...
}

​
Postgres

Here’s an example payload for creating a pipeline that delivers to a Postgres database: 
{
  ...
  "delivery": {
    "adapter": "POSTGRES",
    "connectionUri": "postgres://...",
    "table": "vitalik_token_transfers",
    "uniqueKeys": ["transaction_hash", "log_index"]
  },
  ...
}
Make sure your database table is already setup! Importantly, this also includes ensuring that there’s a unique / primary key index on the table matching the provided uniqueKeys in the pipeline.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Pipeline to save

​
name
string
required
​
transformation
string
required
​
filter
string
required
​
filterKeys
string[]
required
​
networks
string[]
required
​
delivery
object
required
​
enabled
boolean

Response

success

​
message
string
required