Show webhook

GET

/v1/webhooks/{id}

const url = 'http://api.disclosebot.localdev:3000/v1/webhooks/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/webhooks/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

required

string

Responses

200

Successful

application/vnd.api+json

object

data

required

object

required

string format: uuid

type

required

string

Allowed values: webhook

attributes

required

object

name

required

string

short_description

string

nullable

url

required

string format: uri

enabled

required

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

relationships

object

trigger_event_types

object

data

Array<object>

object

required

string format: uuid

type

required

string

Allowed values: trigger_event_type

organization

object

data

object

required

string format: uuid

type

required

string

Allowed values: organization

tunnel_endpoint

object

data

object

string format: uuid

type

string

Allowed values: tunnel_endpoint

local_app

object

data

object

string format: uuid

type

string

Allowed values: local_app

Example

{
  "data": {
    "type": "webhook",
    "relationships": {
      "trigger_event_types": {
        "data": [
          {
            "type": "trigger_event_type"
          }
        ]
      },
      "organization": {
        "data": {
          "type": "organization"
        }
      },
      "tunnel_endpoint": {
        "data": {
          "type": "tunnel_endpoint"
        }
      },
      "local_app": {
        "data": {
          "type": "local_app"
        }
      }
    }
  }
}

401

Unauthorized

404

Not found