Deactivate one config

Deactivate a webhooks config by ID, to stop receiving webhooks to its endpoint.

PUT /api/webhooks/configs/{id}/deactivate

Try it

Deactivate one config

cURL

curl --request PUT \
  --url http://localhost/api/webhooks/configs/{id}/deactivate \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "endpoint": "https://example.com",
    "secret": "V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3",
    "eventTypes": [
      "TYPE1",
      "TYPE2"
    ],
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

Config ID

Example:

"4997257d-dfb6-445b-929c-cbe2ab182818"

Response

200

application/json

Config successfully deactivated.

data · object · required

Show child attributes

data. id · string<uuid> · required

data. endpoint · string · required

Example:

"https://example.com"

data. secret · string · required

Example:

"V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"

data. eventTypes · string[] · required

Example:

["TYPE1", "TYPE2"]

data. active · boolean · required

Example:

true

data. createdAt · string<date-time> · required

data. updatedAt · string<date-time> · required