Webhooks

Use Webhooks to connect Yardstik with your application. You can configure them to notify you of various events when they occur in your account.

See the Using Webhooks section.

List all webhooks

Retrieve a list of webhooks for the given account ID.

SecurityApiKey

Request

query Parameters

order	string Order listing results in ascending or descending order, when using `order_by`. Accepted values are `asc` or `desc`. If not passed, defaults to ascending `asc`. Examples: descending order=desc
order_by	string Order listing results by a specific property. Examples: created_at order_by=created_at
page	integer The page number to retrieve.
per_page	integer The maximum number of results per page.
query	string Filter listing results by a specific property. Examples: report query[created_at_gteq]=2022-01-01T00:00:00.000Z

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/webhooks

Request samples

curl
Node.js
Ruby
Python
C#

Response samples

200
400
401
403

application/json

[{"id": "bc0bb48c-d1f9-4b02-a965-3ce39677532f",
"url": "https://google.com",
"enabled": true,
"webhook_type": "candidate.created",
"webhook_description": "A candidate has been created."
}
]

Create a webhook

SecurityApiKey

Request

Request Body schema: application/json

url	string
webhook_type_id	string

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

post/webhooks

Request samples

application/json

{"webhook_type_id": "c6b6e55f-5b3a-479a-9ea8-d95d13856c7d",
"url": "http://127.0.0.1:8080"
}

Response samples

201
401
403
422

application/json

{"id": "e8b57b13-0038-4c69-99ee-1dae304afd80",
"webhook_type": "candidate.created",
"url": "https://mywebhooksservice.com:8080"
}

Show a webhook

Show a specific webhook for a given ID.

SecurityApiKey

Request

path Parameters

webhook_id

required

string

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/webhooks/{webhook_id}

Request samples

curl
Node.js
Ruby
Python
C#

Response samples

200
401
403

application/json

[{"id": "bc0bb48c-d1f9-4b02-a965-3ce39677532f",
"url": "https://google.com",
"enabled": true,
"webhook_type": "candidate.created",
"webhook_description": "A candidate has been created."
}
]

Update a webhook

Update a webhook for a given ID.

SecurityApiKey

Request

path Parameters

webhook_id

required

string

Request Body schema: application/json

enabled	boolean True if enabled. False if disabled.
url	string Update the webhook URL.

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch/webhooks/{webhook_id}

Request samples

application/json

{"url": "https://api.yardstik.com",
"enabled": false
}

Response samples

201
401
403
422

application/json

{"id": "e8b57b13-0038-4c69-99ee-1dae304afd80",
"webhook_type": "candidate.created",
"url": "http://127.0.0.1:8080"
}

Delete a webhook

Delete a webhook given an Id

SecurityApiKey

Request

path Parameters

webhook_id

required

string

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete/webhooks/{webhook_id}

Request samples

curl
Node.js
Ruby
Python
C#

Response samples

401
403
422

application/json

{"errors": ["Not Authenticated"
]
}

List all webhook types

List all webhook types enabled for your account.
For a list of available types, see Listen for Webhook Events

SecurityApiKey

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/webhook_types

Request samples

curl
Node.js
Ruby
Python
C#

Response samples

200
401
403

application/json

[{"id": "c6b6e55f-5b3a-479a-9ea8-d95d13856c7d",
"system_name": "candidate.created",
"description": "A new candidate has been created."
}
]