Test one config

Test a config by sending a webhook to its endpoint.

GET /api/webhooks/configs/{id}/test

Try it

Test one config

cURL

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

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "webhookID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "config": {
      "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"
    },
    "payload": "{\"data\":\"test\"}",
    "statusCode": 200,
    "retryAttempt": 1,
    "status": "success",
    "nextRetryAfter": "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

OK

data · object · required

Show child attributes

data. id · string<uuid> · required

data. webhookID · string<uuid> · required

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

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

data. config · object · required

Show child attributes

data.config. id · string<uuid> · required

data.config. endpoint · string · required

Example:

"https://example.com"

data.config. secret · string · required

Example:

"V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"

data.config. eventTypes · string[] · required

Example:

["TYPE1", "TYPE2"]

data.config. active · boolean · required

Example:

true

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

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

data. payload · string · required

Example:

"{\"data\":\"test\"}"

data. statusCode · integer · required

Example:

200

data. retryAttempt · integer · required

Example:

1

data. status · string · required

Example:

"success"

data. nextRetryAfter · string<date-time>