Webhooks

/v1/webhooks

GET/v1/webhooks

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks"

curl -X GET "https://example.com/v1/webhooks"

[
  {
    "id": "string",
    "name": null,
    "webhookUrl": "string",
    "products": [
      "string"
    ],
    "events": [
      "string"
    ],
    "includeFutureEvents": true,
    "scope": "string",
    "domainIds": [
      "string"
    ],
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "lastTriggeredAt": null,
    "lastSuccessAt": null,
    "lastFailureAt": null,
    "successCount": 0,
    "failureCount": 0,
    "consecutiveFailures": 0,
    "secretKeyPrefix": null,
    "pausedAt": null,
    "pausedReason": null,
    "pauseThreshold": 0,
    "approvedTlsPort": null,
    "type": null
  }
]

[  {    "id": "string",    "name": null,    "webhookUrl": "string",    "products": [      "string"    ],    "events": [      "string"    ],    "includeFutureEvents": true,    "scope": "string",    "domainIds": [      "string"    ],    "isActive": true,    "createdAt": "2019-08-24T14:15:22Z",    "lastTriggeredAt": null,    "lastSuccessAt": null,    "lastFailureAt": null,    "successCount": 0,    "failureCount": 0,    "consecutiveFailures": 0,    "secretKeyPrefix": null,    "pausedAt": null,    "pausedReason": null,    "pauseThreshold": 0,    "approvedTlsPort": null,    "type": null  }]

Create a new webhook endpoint. The secret is only shown once in the response.

POST/v1/webhooks

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?null|string

webhookUrl*string

products?null|array<string>

events?null|array<string>

includeFutureEvents?boolean

scope?string

domainIds?null|array<string>

type?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "string"
  }'

curl -X POST "https://example.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "webhookUrl": "string"  }'

{
  "webhook": {
    "id": "string",
    "name": null,
    "webhookUrl": "string",
    "products": [
      "string"
    ],
    "events": [
      "string"
    ],
    "includeFutureEvents": true,
    "scope": "string",
    "domainIds": [
      "string"
    ],
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "lastTriggeredAt": null,
    "lastSuccessAt": null,
    "lastFailureAt": null,
    "successCount": 0,
    "failureCount": 0,
    "consecutiveFailures": 0,
    "secretKeyPrefix": null,
    "pausedAt": null,
    "pausedReason": null,
    "pauseThreshold": 0,
    "approvedTlsPort": null,
    "type": null
  },
  "secret": "string"
}

{  "webhook": {    "id": "string",    "name": null,    "webhookUrl": "string",    "products": [      "string"    ],    "events": [      "string"    ],    "includeFutureEvents": true,    "scope": "string",    "domainIds": [      "string"    ],    "isActive": true,    "createdAt": "2019-08-24T14:15:22Z",    "lastTriggeredAt": null,    "lastSuccessAt": null,    "lastFailureAt": null,    "successCount": 0,    "failureCount": 0,    "consecutiveFailures": 0,    "secretKeyPrefix": null,    "pausedAt": null,    "pausedReason": null,    "pauseThreshold": 0,    "approvedTlsPort": null,    "type": null  },  "secret": "string"}

/v1/webhooks/{id}

GET/v1/webhooks/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks/string"

curl -X GET "https://example.com/v1/webhooks/string"

{
  "recentLogs": [
    {
      "publicId": "string",
      "eventType": "string",
      "messageId": null,
      "statusCode": 0,
      "responseTimeMs": 0,
      "success": true,
      "errorMessage": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "attemptNumber": 0
    }
  ],
  "id": "string",
  "name": null,
  "webhookUrl": "string",
  "products": [
    "string"
  ],
  "events": [
    "string"
  ],
  "includeFutureEvents": true,
  "scope": "string",
  "domainIds": [
    "string"
  ],
  "isActive": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "lastTriggeredAt": null,
  "lastSuccessAt": null,
  "lastFailureAt": null,
  "successCount": 0,
  "failureCount": 0,
  "consecutiveFailures": 0,
  "secretKeyPrefix": null,
  "pausedAt": null,
  "pausedReason": null,
  "pauseThreshold": 0,
  "approvedTlsPort": null,
  "type": null
}

{  "recentLogs": [    {      "publicId": "string",      "eventType": "string",      "messageId": null,      "statusCode": 0,      "responseTimeMs": 0,      "success": true,      "errorMessage": null,      "createdAt": "2019-08-24T14:15:22Z",      "attemptNumber": 0    }  ],  "id": "string",  "name": null,  "webhookUrl": "string",  "products": [    "string"  ],  "events": [    "string"  ],  "includeFutureEvents": true,  "scope": "string",  "domainIds": [    "string"  ],  "isActive": true,  "createdAt": "2019-08-24T14:15:22Z",  "lastTriggeredAt": null,  "lastSuccessAt": null,  "lastFailureAt": null,  "successCount": 0,  "failureCount": 0,  "consecutiveFailures": 0,  "secretKeyPrefix": null,  "pausedAt": null,  "pausedReason": null,  "pauseThreshold": 0,  "approvedTlsPort": null,  "type": null}

/v1/webhooks/{id}

PUT/v1/webhooks/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?null|string

webhookUrl?null|string

products?null|array<string>

events?null|array<string>

includeFutureEvents?null|boolean

scope?null|string

domainIds?null|array<string>

isActive?null|boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/webhooks/string" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://example.com/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name": null,
  "webhookUrl": "string",
  "products": [
    "string"
  ],
  "events": [
    "string"
  ],
  "includeFutureEvents": true,
  "scope": "string",
  "domainIds": [
    "string"
  ],
  "isActive": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "lastTriggeredAt": null,
  "lastSuccessAt": null,
  "lastFailureAt": null,
  "successCount": 0,
  "failureCount": 0,
  "consecutiveFailures": 0,
  "secretKeyPrefix": null,
  "pausedAt": null,
  "pausedReason": null,
  "pauseThreshold": 0,
  "approvedTlsPort": null,
  "type": null
}

{  "id": "string",  "name": null,  "webhookUrl": "string",  "products": [    "string"  ],  "events": [    "string"  ],  "includeFutureEvents": true,  "scope": "string",  "domainIds": [    "string"  ],  "isActive": true,  "createdAt": "2019-08-24T14:15:22Z",  "lastTriggeredAt": null,  "lastSuccessAt": null,  "lastFailureAt": null,  "successCount": 0,  "failureCount": 0,  "consecutiveFailures": 0,  "secretKeyPrefix": null,  "pausedAt": null,  "pausedReason": null,  "pauseThreshold": 0,  "approvedTlsPort": null,  "type": null}

/v1/webhooks/{id}

DELETE/v1/webhooks/{id}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

curl -X DELETE "https://example.com/v1/webhooks/string"

curl -X DELETE "https://example.com/v1/webhooks/string"

Empty

Regenerate the webhook secret. The new secret is only shown once.

POST/v1/webhooks/{id}/regenerate-secret

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks/string/regenerate-secret"

curl -X POST "https://example.com/v1/webhooks/string/regenerate-secret"

{
  "secretKey": "string"
}

{  "secretKey": "string"}

Resume a paused webhook. Clears pause state and resets failure counter.

POST/v1/webhooks/{id}/resume

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks/string/resume"

curl -X POST "https://example.com/v1/webhooks/string/resume"

{
  "id": "string",
  "name": null,
  "webhookUrl": "string",
  "products": [
    "string"
  ],
  "events": [
    "string"
  ],
  "includeFutureEvents": true,
  "scope": "string",
  "domainIds": [
    "string"
  ],
  "isActive": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "lastTriggeredAt": null,
  "lastSuccessAt": null,
  "lastFailureAt": null,
  "successCount": 0,
  "failureCount": 0,
  "consecutiveFailures": 0,
  "secretKeyPrefix": null,
  "pausedAt": null,
  "pausedReason": null,
  "pauseThreshold": 0,
  "approvedTlsPort": null,
  "type": null
}

{  "id": "string",  "name": null,  "webhookUrl": "string",  "products": [    "string"  ],  "events": [    "string"  ],  "includeFutureEvents": true,  "scope": "string",  "domainIds": [    "string"  ],  "isActive": true,  "createdAt": "2019-08-24T14:15:22Z",  "lastTriggeredAt": null,  "lastSuccessAt": null,  "lastFailureAt": null,  "successCount": 0,  "failureCount": 0,  "consecutiveFailures": 0,  "secretKeyPrefix": null,  "pausedAt": null,  "pausedReason": null,  "pauseThreshold": 0,  "approvedTlsPort": null,  "type": null}

Get webhook usage information including affected inbound routes.

GET/v1/webhooks/{id}/usage

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks/string/usage"

curl -X GET "https://example.com/v1/webhooks/string/usage"

{
  "webhookId": "string",
  "webhookName": null,
  "affectedRoutes": [
    {
      "id": "string",
      "name": "string",
      "pattern": "string",
      "domainName": "string",
      "actions": [
        "string"
      ],
      "willBeDisabled": true
    }
  ],
  "routesCount": 0,
  "routesToDisable": 0
}

{  "webhookId": "string",  "webhookName": null,  "affectedRoutes": [    {      "id": "string",      "name": "string",      "pattern": "string",      "domainName": "string",      "actions": [        "string"      ],      "willBeDisabled": true    }  ],  "routesCount": 0,  "routesToDisable": 0}

Send a test webhook and return detailed results.

POST/v1/webhooks/{id}/test

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks/string/test"

curl -X POST "https://example.com/v1/webhooks/string/test"

{
  "success": true,
  "statusCode": 0,
  "statusText": null,
  "durationMs": 0,
  "responseBody": null,
  "errorMessage": null,
  "errorType": null,
  "headersSent": null,
  "wouldReceiveRealEvents": true,
  "liveEvents": [
    "string"
  ],
  "dormantEvents": {
    "property1": "string",
    "property2": "string"
  },
  "subscriptionWarning": null
}

{  "success": true,  "statusCode": 0,  "statusText": null,  "durationMs": 0,  "responseBody": null,  "errorMessage": null,  "errorType": null,  "headersSent": null,  "wouldReceiveRealEvents": true,  "liveEvents": [    "string"  ],  "dormantEvents": {    "property1": "string",    "property2": "string"  },  "subscriptionWarning": null}

Get webhook delivery history with pagination and filtering.

GET/v1/webhooks/{id}/deliveries

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default20

cursor?string

status?string

eventType?string

from?string

Formatdate-time

to?string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks/string/deliveries"

curl -X GET "https://example.com/v1/webhooks/string/deliveries"

{
  "items": [
    {
      "publicId": "string",
      "eventType": "string",
      "messageId": null,
      "statusCode": 0,
      "responseTimeMs": 0,
      "success": true,
      "errorMessage": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "attemptNumber": 0
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "publicId": "string",      "eventType": "string",      "messageId": null,      "statusCode": 0,      "responseTimeMs": 0,      "success": true,      "errorMessage": null,      "createdAt": "2019-08-24T14:15:22Z",      "attemptNumber": 0    }  ],  "nextCursor": null,  "hasMore": true}

Retry a failed webhook delivery.

POST/v1/webhooks/{id}/deliveries/{deliveryId}/retry

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

id*string

deliveryId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks/string/deliveries/string/retry"

curl -X POST "https://example.com/v1/webhooks/string/deliveries/string/retry"

{
  "message": "string"
}

{  "message": "string"}

Webhooks

/v1/webhooksCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Create a new webhook endpoint. The secret is only shown once in the response.Copy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

/v1/webhooks/{id}Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

/v1/webhooks/{id}Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

/v1/webhooks/{id}Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

Regenerate the webhook secret. The new secret is only shown once.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Resume a paused webhook. Clears pause state and resets failure counter.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

Get webhook usage information including affected inbound routes.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Send a test webhook and return detailed results.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

404application/json

Get webhook delivery history with pagination and filtering.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

Retry a failed webhook delivery.Copy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

202application/json

400application/json

404application/json

/v1/webhooks

Authorization

Response Body

`application/json`

Create a new webhook endpoint. The secret is only shown once in the response.

Authorization

Request Body

Response Body

`application/json`

`application/json`

/v1/webhooks/{id}

Authorization

Path Parameters

Response Body

`application/json`

/v1/webhooks/{id}

Authorization

Path Parameters

Request Body

Response Body

`application/json`

/v1/webhooks/{id}

Authorization

Path Parameters

Response Body

Regenerate the webhook secret. The new secret is only shown once.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Resume a paused webhook. Clears pause state and resets failure counter.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

Get webhook usage information including affected inbound routes.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Send a test webhook and return detailed results.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Get webhook delivery history with pagination and filtering.

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Retry a failed webhook delivery.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`