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

# WebhookEndpointCreated Schema

> A newly created endpoint, including the signing secret. Includes parameters, response shapes, examples, and implementation notes from the 0xArchive contract.

Source OpenAPI: 0xArchive API 1.7.0; 218 paths; 210 component schemas.

A newly created endpoint, including the signing secret. This is one of the two responses that carry the secret; the other is a rotation. Store it now, because it is not shown again.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `consecutive_failures` | integer:int32 | Failed attempts since the last success. |
| `created_at` | string:date-time | When the endpoint was created. |
| `description` | string | Your own label for the endpoint. |
| `id` | string:uuid | Endpoint identifier. |
| `secret` | string | Signing secret for this endpoint. |
| `status` | string | `active` is serving. |
| `url` | string:uri | HTTPS destination that receives deliveries. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "WebhookEndpointCreated",
  "description": "A newly created endpoint, including the signing secret. This is one of the two responses that carry the secret; the other is a rotation. Store it now, because it is not shown again.",
  "type": "object",
  "required": [
    "consecutive_failures",
    "created_at",
    "description",
    "id",
    "secret",
    "status",
    "url"
  ],
  "properties": {
    "consecutive_failures": {
      "description": "Failed attempts since the last success. Resets to zero on a delivery that lands.",
      "type": "integer",
      "format": "int32",
      "example": 0
    },
    "created_at": {
      "description": "When the endpoint was created.",
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "description": "Your own label for the endpoint.",
      "type": "string",
      "example": "Trading desk alerts"
    },
    "id": {
      "description": "Endpoint identifier.",
      "type": "string",
      "format": "uuid"
    },
    "secret": {
      "description": "Signing secret for this endpoint. Every delivery is signed with it, and your receiver verifies the signature against it.",
      "type": "string",
      "example": "whsec_6f1c0b2a4d8e5f3a9c7b1e0d2f4a6c8b1d3e5f7a9c0b2d4e6f8a1c3b5d7e9f0a"
    },
    "status": {
      "description": "`active` is serving. `disabled` means you switched it off. `auto_disabled` means a long run of failed deliveries switched it off for you; bring it back with the enable route.",
      "type": "string",
      "enum": [
        "active",
        "disabled",
        "auto_disabled"
      ],
      "example": "active"
    },
    "url": {
      "description": "HTTPS destination that receives deliveries.",
      "type": "string",
      "format": "uri",
      "example": "https://example.com/hooks/0xarchive"
    }
  }
}
```

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.