Create webhook

Create a new webhook.

application/json

Request Body required

body object
url URL to send the webhook to (valid absolute URI via RFC 3986)
description string
subscribed_events string[]
headers object
property name* string
state string
metadata object

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

webhook object
id string
description string
url string
subscribed_events string[]
headers object
property name* string
secrets object[]
Array [
id string
value string
]
state string
metadata object
created_at date-time
updated_at date-time

{
  "webhook": {
    "id": "string",
    "description": "string",
    "url": "string",
    "subscribed_events": [
      "string"
    ],
    "headers": {},
    "secrets": [
      {
        "id": "string",
        "value": "string"
      }
    ],
    "state": "string",
    "metadata": {},
    "created_at": "2024-07-13T09:54:48.210Z",
    "updated_at": "2024-07-13T09:54:48.210Z"
  }
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...