Skip to main content
POST
/
event-subscriptions
/
connections
curl --request POST \
  --url https://panel.sendcloud.sc/api/v3/event-subscriptions/connections \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "webhook",
  "configuration": {
    "url": "https://example.com/webhooks/sendcloud",
    "auth_type": "bearer",
    "auth_config": {
      "token": "my-secret-token"
    },
    "extra_headers": {
      "X-Custom-Header": "my-value"
    }
  }
}
'
{
  "data": {
    "id": 1,
    "type": "webhook",
    "configuration": {
      "url": "https://example.com/webhooks/sendcloud",
      "auth_type": "bearer",
      "extra_headers": {
        "X-Custom-Header": "my-value"
      }
    },
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z"
  }
}
Create a new connection that defines an external endpoint for event delivery. Webhook connections require a url and optionally authentication configuration. Supported authentication types are none, bearer, basic, and api_key. Klaviyo connections require only the type field set to klaviyo with an empty configuration object. After creating the connection, use the Start OAuth2 authorization endpoint to connect your Klaviyo account.
Webhook URLs must be publicly accessible and respond with a 2xx status code to acknowledge event delivery.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Body

application/json

Request body for creating a new connection.

​
type
enum<string>
required

The type of connection.

Available options:
webhook,
klaviyo
​
configuration
object
required

The configuration for the connection. The shape depends on the connection type.

For webhook connections, see the webhook configuration fields. For klaviyo connections, configuration can be an empty object as credentials are managed via OAuth2.

Response

Created

Connection created

​
data
Connection · object

A connection defines an external endpoint where event notifications are delivered.