Change the signing secret of a config

Change the signing secret of the endpoint of a webhooks config.

If not passed or empty, a secret is automatically generated. The format is a random string of bytes of size 24, base64 encoded. (larger size after encoding)

PUT /api/webhooks/configs/{id}/secret/change

Try it

Change the signing secret of a config

cURL

curl --request PUT \
  --url http://localhost/api/webhooks/configs/{id}/secret/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret": "V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"
}
'

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"

Body

application/json

secret · string · required

Example:

"V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"

Response

200

application/json

Secret successfully changed.

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