Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Webhooks Integration

Get all auth methods

Get a list of all auth methods configured for the Webhooks integration in your organization.

get/api/v2/integration/webhooks/configuration/auth-method

Query parameters

include'oauth2-client-credentials'

Authentication protocol used by the auth method.

Example:oauth2-client-credentials

Comma-separated list of relationships to include in the response.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "protocol": "oauth2-client-credentials"
      },
      "id": "596da4af-0563-4097-90ff-07230c3f9db3",
      "relationships": {
        "oauth2-client-credentials": {
          "data": {
            "id": "596da4af-0563-4097-90ff-07230c3f9db3",
            "type": "webhooks-auth-method-oauth2-client-credentials"
          }
        }
      },
      "type": "webhooks-auth-method"
    }
  ],
  "included": [
    {
      "attributes": {
        "access_token_url": "https://example.com/oauth/token",
        "audience": "https://api.example.com",
        "client_id": "my-client-id",
        "name": "my-oauth2-auth",
        "protocol": "oauth2-client-credentials",
        "scope": "read:webhooks write:webhooks"
      },
      "id": "596da4af-0563-4097-90ff-07230c3f9db3",
      "type": "webhooks-auth-method-oauth2-client-credentials"
    }
  ]
}