Create Account's Webhook

POST 
/webhooks/

Request

application/json

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the webhook.

url urirequired
check_cert boolean

If true, verify the HTTPS certificate of the webhook URL. Defaults to true.

api_version string
Possible values: [v1]
API version of the webhook.
• v1 - V1

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the webhook.

url urirequired
check_cert boolean

If true, verify the HTTPS certificate of the webhook URL. Defaults to true.

api_version string
Possible values: [v1]
API version of the webhook.
• v1 - V1

multipart/form-data

Body

required

name stringrequired

Possible values: <= 255 characters

Name of the webhook.

url urirequired
check_cert boolean

If true, verify the HTTPS certificate of the webhook URL. Defaults to true.

api_version string
Possible values: [v1]
API version of the webhook.
• v1 - V1

Responses

201

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the webhook.

url urirequired
check_cert boolean

If true, verify the HTTPS certificate of the webhook URL. Defaults to true.

api_version string
Possible values: [v1]
API version of the webhook.
• v1 - V1
created date-timerequired

created_by

object

required

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

changed_by

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "url": "string",
  "check_cert": true,
  "api_version": "v1",
  "created": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "changed": "2024-07-29T15:51:28.071Z",
  "changed_by": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  }
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...