Webhook API:Webhooks

Add a new webhook

Changed on
post/webhooks

Request

  • Base URL
    https://api.jobadder.com/v2
  • URL
    https://api.jobadder.com/v2/webhooks
  • Auth
    OAuth 2
    Authorization code: https://id.jobadder.com/connect/authorize
    Token URL: https://id.jobadder.com/connect/token scopes: offline_access

Request body

namestring nullable required
eventsEventName[] nullable required
urlstring uri nullable required

Target URL that will listen for incoming HTTP POST notification messages.

authorizationstring nullable

Optional authorization header to include with the HTTP POST notification.

status'Enabled' | 'Disabled' | 'Suspended' string

Example request

{
  "authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}

Response

Created

webhookIdstring uuid
namestring nullable
status'Enabled' | 'Disabled' | 'Suspended' | 'Failed' string
urlstring uri nullable
eventsEventName[] nullable
createdAtstring date-time
updatedAtstring date-time
enabledAtstring date-time nullable
disabledAtstring date-time nullable
suspendedAtstring date-time nullable
failedAtstring date-time nullable

Changes

    • info

      added optional request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status