---
title: "Add Webhook"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Add Webhook

`POST /v1/webhooks`

Add a webhook for events enrollments.

## Request body

- WebhookAddRequest
  - `request_context` object, nullable
  - `partner_id` string, required
  - `webhook_url` string, required
  - `headers` string[]
  - `payload_format` 'json' | 'stringified_json' — An enumeration.

## Response `200`

Successful Response

- WebhookAddResponse — This is base response model for all responses in partner service.
  - `response_context` ResponseContext, required
    - `correlation_id` string, required
    - `request_status` 'success' | 'miss' | 'failure', required — The `RequestStatus` class is an enumeration that defines the possible statuses of a request. This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application. Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.
    - `time_took_in_seconds` number, required
  - `created_at` string, date-time, required
  - `last_modified_time` string, date-time, required
  - `webhook_url` string, required
  - `webhook_secret` string, required
  - `headers` string[]
  - `payload_format` 'json' | 'stringified_json' — An enumeration.

## Other responses

- `422` — Validation Error

## Changes

- **2026-06-18** `cdff11b1b0d3` — 2 info
  - added the new optional request property `payload_format`
  - added the optional property `payload_format` to the response with the `200` status
- **2026-05-03** `2a6c444d86c9` — 2 warning
  - removed the request property `payload_format`
  - removed the optional property `payload_format` from the response with the `200` status

[Change history](https://skmtc.dev/explorium-ai/apis/partner-service/changes/v1/webhooks/post.md)

---

[API](https://skmtc.dev/explorium-ai/apis/partner-service.md) · [All operations](https://skmtc.dev/explorium-ai/apis/partner-service/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/explorium-ai/partner-service/revisions/2d72469940e5/schema)