Get Webhook

GET /v2/webhooks/{webhook_nanoid}

Try it

Get Webhook

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/webhooks/{webhook_nanoid} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": {
    "webhook_nanoid": "<string>",
    "company_nanoid": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "team_nanoid": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhook_nanoid · string · required

Unique identifier of the Webhook Endpoint.

Required string length: 15

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. webhook_nanoid · string · required

Unique identifier of the Webhook.

Required string length: 15

data. company_nanoid · string · required

Unique identifier of the company.

Required string length: 15

data. url · string<uri> · required

data. events · string[] · required

data. is_active · boolean · required

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

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

data. team_nanoid · string

Unique identifier of the team, if applicable.

Required string length: 15