/webhook_endpoints (POST)

POST

/webhook_endpoints

curl --request POST \
  --url https://example.com/webhook_endpoints \
  --header 'Content-Type: application/json' \
  --data '{ "event_types": [ "example" ], "url": "example" }'

Request Body^required

Media typeapplication/json

object

event_types

Array<string>

url

required

string

>= 1 characters <= 2048 characters

Example^generated

{
  "event_types": [
    "example"
  ],
  "url": "example"
}

Responses

201

Default Response

Media typeapplication/json

object

signing_secret

required

string

/^whsec_/

webhook_endpoint

required

object

created_at

required

string format: date-time

event_schema_version

required

string

event_types

required

Array<string>

nullable

id

required

string

/^whend_/

previous_signing_secret_expires_at

required

string format: date-time

nullable

status

required

string

Allowed values: active archived inactive

updated_at

required

string format: date-time

url

required

string

Example

{
  "webhook_endpoint": {
    "status": "active"
  }
}

400

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

403

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

404

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}

409

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "request_id": "example"
  }
}