Create a Webhook

post/public/v1/webhooks

post/public/v1/webhooks

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/webhooks' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "string",
  "url": "https://example.com",
  "is_enabled": true,
  "event_types": [
    "candidate.created"
  ]
}'

Response

{
  "data": {
    "id": "w1e2b3h4-o5o6-47k8-9b0c-1d2e3f4a5b6c",
    "description": "Participant sync",
    "url": "https://example.com/webhooks/astalty",
    "is_enabled": true,
    "event_types": [
      "participant.created",
      "participant.updated"
    ],
    "signing_secret": "6XmDkuNTiTGCxYUFtVvxDbxqAoJTNjkQKDBGqSmChHtCXtBVrGUVJHDDkHkPWmYd",
    "archived_at": "2025-01-01T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Body

application/json

descriptionstringrequiredmax length 255
urlstring<uri>requiredmax length 255
is_enabledbooleanrequired
event_typesenum<string>[]requiredmin items 1max items 18

Response

200application/json

WebhookResource

dataobjectrequired
▶Show 8 child attributesHide child attributes
- idstringrequired
  Example:w1e2b3h4-o5o6-47k8-9b0c-1d2e3f4a5b6c
- descriptionstringrequired
  Example:Participant sync
- urlstringrequired
  Example:https://example.com/webhooks/astalty
- is_enabledbooleanrequired
  Example:true
- event_typesstring[]required
- signing_secretstringrequired
  Example:6XmDkuNTiTGCxYUFtVvxDbxqAoJTNjkQKDBGqSmChHtCXtBVrGUVJHDDkHkPWmYd
- archived_atstring | nullrequired
  Example:2025-01-01T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
422Validation error

Command Palette

Authorization

Body

Response

Errors