Register a webhook endpoint owned by this installation.

POST

/apps/webhooks/subscriptions

curl --request POST \
  --url https://your-store.myciqra.com/apps/webhooks/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "eventTypes": [ "example" ], "url": "example" }'

Required scope: write_webhooks — an installation token without it receives 403.

Authorizations

• bearerAuth
  write_webhooks

Request Body^required

Media typeapplication/json

object

description

required

null | string

eventTypes

required

Array<string> | null

url

required

null | string

Example^generated

{
  "description": "example",
  "eventTypes": [
    "example"
  ],
  "url": "example"
}

Responses

200

OK

Media typeapplication/json

object

autoDisabledAt

null | string format: date-time

autoDisabledReason

null | string

consecutiveFailures

integer | string format: int32

0 /^-?(?:0|[1-9]\d*)$/

createdAt

required

string format: date-time

description

required

null | string

eventTypes

required

Array<string>

hasSigningSecret

required

boolean

id

required

string format: uuid

installationId

null | string format: uuid

isActive

required

boolean

isDeliverable

required

boolean

updatedAt

required

null | string format: date-time

url

required

string

Example

{
  "consecutiveFailures": 0
}

400

Bad Request

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}