Skip to main content

Update a webhook status

PUT
/partner/v1.0/webhooks/:webhook_id/status

Update a webhook status in the Pulsifi system.


Headers​

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


Path Parameters​

webhook_id string (uuid) Required
The unique identifier for the webhook created in the Pulsifi system.


Body​

status enum Required
The status of the webhook.
  • active
  • inactive


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.
PUT /partner/v1.0/webhooks/:webhook_id/status
curl -X PUT 'https://staging.api.pulsifi.me/partner/v1.0/webhooks/{webhook_id}/status' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-d '{
  "status": "inactive"
}'
Response
{
  "data": {
    "id": "<Pulsifi Webhook ID>",
    "partner_id": "<Partner ID>",
    "name": "<Webhook Name>",
    "url": "<Webhook URL>",
    "events": ["candidate_application_result_ready"],
    "status": "inactive",
    "is_deleted": false,
    "created_at": "2024-10-04T04:06:55.124Z",
    "created_by": 1
  },
  "meta": null
}