Retrieve webhook - Respondent API

GET

webhooks

Retrieve webhook

curl --request GET \
  --url https://api-staging.respondent.io/v1/webhooks \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'

{
  "id": "<string>",
  "url": "<string>",
  "privateKey": "<string>",
  "teamId": "<string>",
  "organizationId": "<string>"
}

Headers

x-api-key

string

required

x-api-secret

string

required

Response

200 - application/json

string<ObjectId>

required

url

string

required

The URL to send the webhook payload to.

privateKey

string

required

The secret key to be used to sign the webhook payload.

teamId

string<ObjectId>

organizationId

string<ObjectId>

Retrieve specific webhookRetrieve a specific webhook by ID, including its URL, status, and configured event types.

⌘I

Retrieve webhook

curl --request GET \
  --url https://api-staging.respondent.io/v1/webhooks \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'

{
  "id": "<string>",
  "url": "<string>",
  "privateKey": "<string>",
  "teamId": "<string>",
  "organizationId": "<string>"
}