Retrieve webhook event types

GET

webhooks

{webhookId}

event-types

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

{
  "eventTypes": [
    "PROJECTS.UPDATED"
  ]
}

Headers

x-api-key

string

required

x-api-secret

string

required

Path Parameters

webhookId

string

required

Response

200 - application/json

eventTypes

enum<string>[]

required

The webhook event type to simulate.

Available options:

PROJECTS.UPDATED,

SCREENER_RESPONSES.CREATED,

SCREENER_RESPONSES.UPDATED,

MESSAGES.CREATED,

CONVERSATIONS.CREATED

Simulate webhook eventMaking a request to this endpoint will trigger a test webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. Will use random resource ids for the event.

⌘I

Retrieve webhook event types

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

{
  "eventTypes": [
    "PROJECTS.UPDATED"
  ]
}

Getting started

Project Setup

Screener Response Handling

Messaging

Lookup and Reference Data

Webhooks

Team Tools

Retrieve webhook event types

Headers

Path Parameters

Response