For the complete documentation index, see llms.txt. This page is also available as Markdown.

Triggers

Trigger lifecycle management

List triggers

get
Query parameters
sigsstringOptional

Comma-separated list of trigger signatures to filter by

functionCidstringOptional

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
signerstringOptional

A valid EVM (0x-prefixed hex) address.

Example: 0x1234567890abcdef1234567890abcdef12345678
activebooleanOptional

Filter by active state

createdAfterintegerOptional

Unix timestamp in milliseconds.

Example: 1700000000000
createdBeforeintegerOptional

Unix timestamp in milliseconds.

Example: 1700000000000
offsetintegerOptionalDefault: 0
limitinteger · min: 1 · max: 100OptionalDefault: 10
sortinteger · enumOptional

Sort order: 1 for ascending, -1 for descending

Default: -1Possible values:
Responses
200

List of triggers

application/json
sigstringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
functionCidstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
signerstringRequired

A valid EVM (0x-prefixed hex) address.

Example: 0x1234567890abcdef1234567890abcdef12345678
versionstringRequired

A semantic version string.

Example: 1.0.0
descriptionstringRequired
deactivateSigstringOptional

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
createdAtstring · date-timeRequired
configone ofRequired

Trigger schedule configuration. Discriminated by the integer type field: 0 → CronTriggerConfig, 1 → EventTriggerConfig, 2 → OnceTriggerConfig.

or
or
executionFeeLimitstringRequired

A non-negative integer represented as a decimal string.

Example: 1000000000000000000
minValidationsintegerRequired
endDateintegerRequired

Unix timestamp in milliseconds.

Example: 1700000000000
get/triggers
GET /triggers HTTP/1.1
Host: api-protocol.mimic.fi
Accept: */*
200

List of triggers

[
  {
    "sig": "0xabc...def",
    "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
    "signer": "0x1234567890abcdef1234567890abcdef12345678",
    "version": "1.0.0",
    "description": "text",
    "deactivateSig": "0xabc...def",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "input": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "config": {
      "type": 0,
      "schedule": "text",
      "delta": "text",
      "endDate": 1700000000000
    },
    "executionFeeLimit": "1000000000000000000",
    "minValidations": 1,
    "types": {
      "Input": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "Config": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "Trigger": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "name": "text",
          "type": "text"
        }
      ]
    },
    "endDate": 1700000000000
  }
]

Create a new trigger

post

Registers a new trigger. The typedData is an EIP-712 typed data structure signed by signer. The signature is recovered on-chain to verify ownership.

Body
descriptionstringRequired
sigstringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
signerstringRequired

A valid EVM address (0x-prefixed, 20 bytes).

Example: 0x1234567890abcdef1234567890abcdef12345678
Responses
200

Trigger created

application/json
sigstringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
functionCidstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
signerstringRequired

A valid EVM (0x-prefixed hex) address.

Example: 0x1234567890abcdef1234567890abcdef12345678
versionstringRequired

A semantic version string.

Example: 1.0.0
descriptionstringRequired
deactivateSigstringOptional

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
createdAtstring · date-timeRequired
configone ofRequired

Trigger schedule configuration. Discriminated by the integer type field: 0 → CronTriggerConfig, 1 → EventTriggerConfig, 2 → OnceTriggerConfig.

or
or
executionFeeLimitstringRequired

A non-negative integer represented as a decimal string.

Example: 1000000000000000000
minValidationsintegerRequired
endDateintegerRequired

Unix timestamp in milliseconds.

Example: 1700000000000
post/triggers
POST /triggers HTTP/1.1
Host: api-protocol.mimic.fi
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "description": "text",
  "typedData": {
    "types": {
      "Input": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "Config": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "Trigger": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "name": "text",
          "type": "text"
        }
      ]
    },
    "values": {
      "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
      "version": "1.0.0",
      "input": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "config": {
        "type": 0,
        "schedule": "text",
        "delta": "text",
        "endDate": 1700000000000
      },
      "executionFeeLimit": "1000000000000000000",
      "minValidations": 1
    }
  },
  "sig": "0xabc...def",
  "signer": "0x1234567890abcdef1234567890abcdef12345678"
}
{
  "sig": "0xabc...def",
  "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
  "signer": "0x1234567890abcdef1234567890abcdef12345678",
  "version": "1.0.0",
  "description": "text",
  "deactivateSig": "0xabc...def",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "input": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config": {
    "type": 0,
    "schedule": "text",
    "delta": "text",
    "endDate": 1700000000000
  },
  "executionFeeLimit": "1000000000000000000",
  "minValidations": 1,
  "types": {
    "Input": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Config": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Trigger": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  },
  "endDate": 1700000000000
}

Compute EIP-712 sign parameters for a trigger

post

Returns the EIP-712 typed data structure (domain, primaryType, types, and message) needed to sign a new trigger. The caller must sign the returned message and submit it with the signature to POST /triggers.

Body
functionCidstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
versionstringRequired

A semantic version string.

Example: 1.0.0
configone ofRequired

Trigger schedule configuration. Discriminated by the integer type field: 0 → CronTriggerConfig, 1 → EventTriggerConfig, 2 → OnceTriggerConfig.

or
or
Responses
200

EIP-712 sign parameters

application/json

EIP-712 typed data structure ready to be signed by the caller

primaryTypestringRequiredExample: Trigger
post/triggers/sign-params
POST /triggers/sign-params HTTP/1.1
Host: api-protocol.mimic.fi
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
  "version": "1.0.0",
  "input": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config": {
    "type": 0,
    "schedule": "text",
    "delta": "text",
    "endDate": 1700000000000
  }
}
{
  "domain": {
    "name": "Mimic Protocol - Registry",
    "version": "1"
  },
  "primaryType": "Trigger",
  "types": {
    "Input": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Config": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Trigger": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  },
  "message": {
    "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
    "version": "1.0.0",
    "input": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "config": {
      "type": 0,
      "schedule": "text",
      "delta": "text",
      "endDate": 1700000000000
    },
    "executionFeeLimit": "1000000000000000000",
    "minValidations": 1
  }
}

Get a trigger by its signature

get
Path parameters
sigstringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
Responses
200

Trigger details

application/json
sigstringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
functionCidstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco
signerstringRequired

A valid EVM (0x-prefixed hex) address.

Example: 0x1234567890abcdef1234567890abcdef12345678
versionstringRequired

A semantic version string.

Example: 1.0.0
descriptionstringRequired
deactivateSigstringOptional

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
createdAtstring · date-timeRequired
configone ofRequired

Trigger schedule configuration. Discriminated by the integer type field: 0 → CronTriggerConfig, 1 → EventTriggerConfig, 2 → OnceTriggerConfig.

or
or
executionFeeLimitstringRequired

A non-negative integer represented as a decimal string.

Example: 1000000000000000000
minValidationsintegerRequired
endDateintegerRequired

Unix timestamp in milliseconds.

Example: 1700000000000
get/triggers/{sig}
GET /triggers/{sig} HTTP/1.1
Host: api-protocol.mimic.fi
Accept: */*
{
  "sig": "0xabc...def",
  "functionCid": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
  "signer": "0x1234567890abcdef1234567890abcdef12345678",
  "version": "1.0.0",
  "description": "text",
  "deactivateSig": "0xabc...def",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "input": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config": {
    "type": 0,
    "schedule": "text",
    "delta": "text",
    "endDate": 1700000000000
  },
  "executionFeeLimit": "1000000000000000000",
  "minValidations": 1,
  "types": {
    "Input": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Config": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "Trigger": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  },
  "endDate": 1700000000000
}

Deactivate one or more triggers

post

Permanently deactivates one or more triggers. The signature must be signed by the original trigger signer, and all provided triggerSigs must belong to that same signer.

Body
triggerSigsstring[] · min: 1Required

Trigger signatures to deactivate

Example: 0xabc...def
signaturestringRequired

A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix).

Example: 0xabc...def
Responses
204

Triggers deactivated

No content

post/triggers/deactivate
POST /triggers/deactivate HTTP/1.1
Host: api-protocol.mimic.fi
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "triggerSigs": [
    "0xabc...def"
  ],
  "signature": "0xabc...def"
}

No content

Last updated