Skip to main content

Create a webhook

POST
/partner/v1.0/webhooks

Creates a new webhook in the Pulsifi system.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Bearer {access_token}


Body​

name string Required
The name of the webhook.
url string (URL) Required
The URL to which the webhook will send data.
events array enum Required
The events that trigger the webhook.
secret string Optional
The secret in the webhook headers, ensuring verification.


Response​

200 OK.

Parameters
id string (uuid)
The unique identifier for the webhook created in the Pulsifi system.
partner_id number
The unique identifier for partners in the Pulsifi system.
name string
The name of the webhook.
url string (URL)
The URL to which the webhook will send data.
events array enum
The events that trigger the webhook.
status enum
The status of the webhook.
  • active
  • inactive
is_deleted boolean
Indicates whether the webhook is deleted.
created_at string (UTC date)
The date and time when the webhook was created (in UTC format).
created_by number
The unique identifier for partners in the Pulsifi system.
POST /partner/v1.0/webhooks
curl -X POST 'https://api.pulsifi.me/partner/v1.0/webhooks' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-d '{
  "name": "Webhook 1",
  "url": "https://example.com/my/webhook/endpoint",
  "events": [
  "candidate_application_result_ready"
  ],
  "secret": "string"
}'
Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "partner_id": 1,
  "name": "Webhook 1",
  "url": "https://example.com/my/webhook/endpoint",
  "events": ["candidate_application_result_ready"],
  "status": "active",
  "is_deleted": false,
  "created_at": "2024-10-04T04:06:55.124Z",
  "created_by": 1
}