Skip to main content

Get all webhook details

GET
/partner/v1.0/webhooks

Get list of webhooks detail.


Headers​

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


Query Parameters​

page number Optional
Indicates which specific page of results you want to retrieve. The default value is 1.
page_size number Optional
Indicates how many items should be included in each page of results. The default value is 25.
sort_by string Optional
Comma separated sortable fields (e.g., created_at, +created_at, -created_at, name, +name, -name).
status string Optional
The status of the webhook (e.g., active, inactive).
q string Optional
Keyword to filter with webhook name.


Response​

200 OK.

Parameters
total_count number
The total number of webhooks.
result array object
The list of webhooks.
Child 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.
GET /partner/v1.0/webhooks/?page=:page&page_size=:limit:&sort_by=:string:&status=:string:&q=:string:
curl -X GET 'https://api.pulsifi.me/partner/v1.0/webhooks/?page={page}&page_size={limit}&sort_by={string}&status={string}&q={string}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
Response
{
  "total_count": 1,
  "result": [
      {
      "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
      }
  ]
}