POST
/
v1
/
organizations
/
webhooks
/
Create Webhook
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/webhooks/ \
  --header 'Content-Type: application/json' \
  --data '{
  "webhook_id": "<string>",
  "webhook_name": "<string>",
  "internal_id": "<string>",
  "event_types": [
    "object.created"
  ],
  "channels": [
    {
      "channel": "email",
      "configs": {
        "to_addresses": [
          "<string>"
        ],
        "subject_template": "<string>",
        "body_template": "<string>",
        "content_type": "html",
        "cc_addresses": [
          "<string>"
        ],
        "bcc_addresses": [
          "<string>"
        ]
      }
    }
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}'
{
  "webhook_id": "<string>",
  "webhook_name": "<string>",
  "event_types": [
    "object.created"
  ],
  "channels": [
    {
      "channel": "email",
      "configs": {
        "to_addresses": [
          "<string>"
        ],
        "subject_template": "<string>",
        "body_template": "<string>",
        "content_type": "html",
        "cc_addresses": [
          "<string>"
        ],
        "bcc_addresses": [
          "<string>"
        ]
      }
    }
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

Body

application/json

Represents a configured webhook for an organization.

​
webhook_name
string
required

Human-readable name for the webhook.

​
event_types
enum<string>[]
required

A list of event types that this webhook subscribes to.

​
channels
WebhookChannel · object[]
required

A list of channels to notify for the subscribed events.

​
webhook_id
string

Unique identifier for the webhook.

​
internal_id
string | null

The internal ID of the organization that owns this webhook.

​
is_active
boolean
default:true

Whether the webhook is currently active and should send notifications.

​
created_at
string<date-time>

Timestamp of when the webhook was created.

​
updated_at
string<date-time>

Timestamp of the last update.

Response

Successful Response

Represents a configured webhook for an organization.

​
webhook_name
string
required

Human-readable name for the webhook.

​
event_types
enum<string>[]
required

A list of event types that this webhook subscribes to.

​
channels
WebhookChannel · object[]
required

A list of channels to notify for the subscribed events.

​
webhook_id
string

Unique identifier for the webhook.

​
is_active
boolean
default:true

Whether the webhook is currently active and should send notifications.

​
created_at
string<date-time>

Timestamp of when the webhook was created.

​
updated_at
string<date-time>

Timestamp of the last update.