Get public webhook settings

GET/v1/settings/developer/webhooks

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

app_idstringrequired

endpointsSettingsWebhookEndpointItem[] | nullrequired

Show properties

Array of SettingsWebhookEndpointItem

created_atstring

descriptionstring

enabledbooleanrequired

event_typesstring[] | nullrequired

idstringrequired

masked_signing_secretstring

updated_atstring

urlstringrequired

supported_eventsSettingsWebhookSupportedEventItem[] | nullrequired

Show properties

Array of SettingsWebhookSupportedEventItem

categorystringrequired

descriptionstringrequired

keystringrequired

sample_payloadanyrequired

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/settings/developer/webhooks"

const response = await fetch("/v1/settings/developer/webhooks", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/settings/developer/webhooks",
)

Response

{
  "app_id": "string",
  "endpoints": [
    {
      "created_at": "string",
      "description": "string",
      "enabled": true,
      "event_types": [
        "string"
      ],
      "id": "string",
      "masked_signing_secret": "string",
      "updated_at": "string",
      "url": "string"
    }
  ],
  "supported_events": [
    {
      "category": "string",
      "description": "string",
      "key": "string",
      "sample_payload": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}