> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Webhook Endpoint

> Register a URL to receive events

[← Webhooks](/api-reference/webhooks/overview)

Register an HTTPS URL that receives the organization's events. The response is the **only** time the signing secret is returned.

<Warning>
  **Beta.** Part of the webhooks API, currently in beta. The contract may still change before general availability.
</Warning>

<RequestExample>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X POST "https://api.dcycle.io/v2/webhook-endpoints" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{
      "url": "https://erp.example.com/dcycle/webhooks",
      "description": "ERP integration",
      "event_types": [
        "ingest_job.finished"
      ]
    }'
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import os

  import requests

  response = requests.post(
      "https://api.dcycle.io/v2/webhook-endpoints",
      headers={
          "x-api-key": os.environ["DCYCLE_API_KEY"],
          "x-organization-id": os.environ["DCYCLE_ORG_ID"],
      },
      json={
          "url": "https://erp.example.com/dcycle/webhooks",
          "description": "ERP integration",
          "event_types": [
              "ingest_job.finished"
          ]
      },
      timeout=30,
  )
  response.raise_for_status()
  print(response.status_code, response.json())
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const response = await axios.post('https://api.dcycle.io/v2/webhook-endpoints', {
      "url": "https://erp.example.com/dcycle/webhooks",
      "description": "ERP integration",
      "event_types": [
        "ingest_job.finished"
      ]
    }, {
    headers: {
      'x-api-key': process.env.DCYCLE_API_KEY,
      'x-organization-id': process.env.DCYCLE_ORG_ID,
    },
  });
  console.log(response.status, response.data);
  ```
</RequestExample>

<ResponseExample>
  ```json 201 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "id": "5c9e2f14-8b7a-4d3e-9f60-1a2b3c4d5e6f",
    "url": "https://erp.example.com/dcycle/webhooks",
    "description": "ERP integration",
    "event_types": [
      "ingest_job.finished"
    ],
    "enabled": true,
    "consecutive_failures": 0,
    "disabled_reason": null,
    "created_at": "2026-10-01T09:12:44.512031",
    "updated_at": "2026-10-01T09:12:44.512031",
    "secret": "whsec_kq3v0VJ9pX2rT7mB4nL8dH1sF6gW5yC0eA3uZ9iO2tQ"
  }
  ```
</ResponseExample>

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  API key of an **organization admin**.

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  The organization that owns the endpoints.

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Must be `application/json`
</ParamField>

### Body Parameters

<ParamField body="url" type="string" required>
  HTTPS URL, up to 2,048 characters, that resolves to a public address. See [URL requirements](/api-reference/webhooks/overview#url-requirements).

  **Example:** `"https://erp.example.com/dcycle/webhooks"`
</ParamField>

<ParamField body="event_types" type="array[string]" required>
  Events to receive, at least one. **Available values:** `ingest_job.finished`.
</ParamField>

<ParamField body="description" type="string | null">
  Up to 255 characters, to recognize the endpoint.
</ParamField>

<ParamField body="enabled" type="boolean" default="true">
  Create it disabled to set it up before it starts receiving.
</ParamField>

## Response

The endpoint and its secret (`201 Created`):

<ResponseField name="id" type="uuid">Endpoint id.</ResponseField>
<ResponseField name="url" type="string">Where the events are sent.</ResponseField>
<ResponseField name="description" type="string | null">Free text to recognize the endpoint.</ResponseField>
<ResponseField name="event_types" type="array[string]">Subscribed events. **Available values:** `ingest_job.finished`.</ResponseField>
<ResponseField name="enabled" type="boolean">Disabled endpoints receive nothing.</ResponseField>
<ResponseField name="consecutive_failures" type="integer">Deliveries in a row that ended `failed`. At 5 the endpoint is disabled.</ResponseField>
<ResponseField name="disabled_reason" type="string | null">`TOO_MANY_FAILURES` when Dcycle disabled the endpoint; `null` otherwise.</ResponseField>
<ResponseField name="created_at" type="datetime">UTC.</ResponseField>
<ResponseField name="updated_at" type="datetime">UTC.</ResponseField>

<ResponseField name="secret" type="string">
  Signing secret (`whsec_…`). **Shown only in this response**: store it to [verify signatures](/api-reference/webhooks/overview#verifying-the-signature).
</ResponseField>

## Common Errors

### 401 Unauthorized

Missing or invalid API key.

### 403 Forbidden

`ORG_ADMIN_REQUIRED`: only organization admins can manage webhook endpoints. `LOGGED_USER_NOT_MEMBER`: the API key's user is not a member of the organization.

### 422 Unprocessable Entity

The body is invalid, in the standard validation format. The URL must use `https`, point to a public host and carry no
credentials; `event_types` needs at least one subscribable event.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": [
    { "loc": ["body", "url"], "msg": "Value error, The URL must point to a public host", "type": "value_error" }
  ]
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Send Test Event" icon="paper-plane" href="/api-reference/webhooks/test-endpoint">
    Check it end to end
  </Card>

  <Card title="Webhooks" icon="book" href="/api-reference/webhooks/overview">
    Events, signatures and retries
  </Card>
</CardGroup>