PCRecruiter API
Search... K

Appearance

Create/modify a webhook.​

POST
/AutomationPlans/webhook

Authorizations​

Bearer

Please create a SessionId using the access-token endpoint and enter it here.

TypeHTTP (bearer)

Parameters​

Query Parameters

applicationName*

A unique application name for the web hook.
Note that application names are unique per user, so two users can have the same application name and they will be separate from each other.

Typestring
Required
postURL*

A URL to connect to when the web hook is activated.
The record id can also be merged into the URL, such as [[Candidate_Id]], [[Company_Id]], or [[Job_Id]].
Example: postURL: 'https://mydomain.com/PCR/hook.aspx?interviewId=[[Sendout_Id]]'

Typestring
Required
recordType*

The PCRecruiter record type that can activate the web hook.
recordType:
'RECORD_TYPE_COMPANIES' |
'RECORD_TYPE_CANDIDATES' |
'RECORD_TYPE_POSITIONS'{ RECORD_TYPE_NONE=0, RECORD_TYPE_COMPANIES=1, RECORD_TYPE_CANDIDATES=2, RECORD_TYPE_POSITIONS=3, RECORD_TYPE_PRODUCTS=4, RECORD_TYPE_USERS=5, RECORD_TYPE_SENDOUTS=6, RECORD_TYPE_GROUPS=8, RECORD_TYPE_AGENTS=10, RECORD_TYPE_EMAIL=11, RECORD_TYPE_ROLLUPS=12, RECORD_TYPE_SCRIPTS=13, RECORD_TYPE_CANDIDATE_ATTACHMENTS=14, RECORD_TYPE_COMPANY_ATTACHMENTS=15, RECORD_TYPE_POSITION_ATTACHMENTS=16, RECORD_TYPE_CANDIDATE_PROFILES=17, RECORD_TYPE_PROFILETEMPLATES=18, RECORD_TYPE_COMPANY_FIELDS=21, RECORD_TYPE_CANDIDATE_FIELDS=22, RECORD_TYPE_POSITION_FIELDS=23, RECORD_TYPE_COMMISSIONS=24, RECORD_TYPE_EXPENSES=25, RECORD_TYPE_FEES=26, RECORD_TYPE_HOUR_RECORDS=27, RECORD_TYPE_TIMESHEETS=28, RECORD_TYPE_TRANSACTIONS=29, RECORD_TYPE_WORK_HISTORY=30, RECORD_TYPE_PLACEMENTS=31, RECORD_TYPE_CALENDAR=32, RECORD_TYPE_REFERENCES=33, RECORD_TYPE_MILITARY=34, RECORD_TYPE_LICENSING=35, RECORD_TYPE_EDUCATION=36, RECORD_TYPE_EEOC=37, RECORD_TYPE_RESUMES=38, RECORD_TYPE_PLANNER=50, RECORD_TYPE_LETTERS=55, RECORD_TYPE_DASHBOARD_TEAM=56, RECORD_TYPE_PERMPLACEMENTS=57, RECORD_TYPE_TEMPPLACEMENTS=58, RECORD_TYPE_JOB_BOARD_CONFIG=59, RECORD_TYPE_SENDOUT_FIELDS=60, RECORD_TYPE_POSITION_ASSOCIATED_ROLLUPS=61, RECORD_TYPE_ROLLUP_NAMES=62, RECORD_TYPE_ROLLUP_COMPANIES=63, RECORD_TYPE_ROLLUP_POSITIONS=64, RECORD_TYPE_CAMPAIGNS=65, RECORD_TYPE_CAMPAIGN_SENDS=66, RECORD_TYPE_LEDGER_RECORDS=67, RECORD_TYPE_PRESENTATIONS=68, RECORD_TYPE_PRESENTATION_IMAGE=69, RECORD_TYPE_GLOBAL_ATTACHMENT=70, RECORD_TYPE_CANDIDATE_PRESENTATIONS=71, RECORD_TYPE_PRESENTATION_ACTIVITY=72, RECORD_TYPE_PIPELINE_EMAILS=73, RECORD_TYPE_AUTOPLAN_TRIGGERS=74, RECORD_TYPE_AUTOPLAN_ACTIONSCRIPTS=75, RECORD_TYPE_PIPELINE_TEMPLATES=76, RECORD_TYPE_PIPELINE_STEPS=77, RECORD_TYPE_PIPELINE_ACTIVITIES=78, RECORD_TYPE_LINKS=79, RECORD_TYPE_TAGS=80, RECORD_TYPE_FEEDBACK=81, RECORD_TYPE_CAMPAIGN_STEPS=82, RECORD_TYPE_CAMPAIGN_ANALYTICS=83, RECORD_TYPE_CAMPAIGN_RECIPIENTS=84, RECORD_TYPE_AUTOPLAN_QUEUES=85, RECORD_TYPE_CAMPAIGN_LINKS=86, RECORD_TYPE_RECIPIENTS=87, ONBOARDING_TASKS=88, RECORD_TYPE_EVERIFY_TASK=89, RECORD_TYPE_CHATACCOUNTS=90, RECORD_TYPE_CHATCONVERSATIONS=91, RECORD_TYPE_CHATMESSAGES=92, RECORD_TYPE_CHATPARTICIPANTS=93, RECORD_TYPE_CHATREACTIONS=94, RECORD_TYPE_CHATACCOUNTSTATE=95, RECORD_TYPE_SUBMITTAL_RECORDS=96, RECORD_TYPE_SHARED_ATTACHMENTS=97, RECORD_TYPE_CHATATTACHMENTS=98, RECORD_TYPE_PROFILE_CACHE=99, RECORD_TYPE_DEVICE_RECORDS=100, RECORD_TYPE_COMPANY_ACTIVITIES=101, RECORD_TYPE_CANDIDATE_ACTIVITIES=102, RECORD_TYPE_POSITION_ACTIVITIES=103, RECORD_TYPE_PRESENTATION_ACTIONS=104, RECORD_TYPE_SIGNER_RECORDS=116, RECORD_TYPE_RECORD_OWNERS=117, RECORD_TYPE_GDPR_CONSENT=118, RECORD_TYPE_OBJECTIVES=200, RECORD_TYPE_ROLLUP_OBJECTIVES=201, RECORD_TYPE_OBJECTIVE_FIELDS=202, RECORD_TYPE_OBJECTIVE_ATTACHMENTS=203, RECORD_TYPE_OBJECTIVE_NOTES=204, RECORD_TYPE_DEALS=205, RECORD_TYPE_DEAL_FIELDS=206, RECORD_TYPE_DEAL_ACTIVITIES=207, RECORD_TYPE_RECORD_TRENDS=208, RECORD_TYPE_MAIL_SERVERS=246, RECORD_TYPE_MAIL_FOLDERS=247, RECORD_TYPE_MAIL_RULES=248, RECORD_TYPE_NO_EMAIL_ACTIVITY=249, RECORD_TYPE_ROLLUP_COMBINED=250, RECORD_TYPE_RING_CENTRAL=251, RECORD_TYPE_EMAIL_ALIASES=252, RECORD_TYPE_NOTIFICATIONS=253, RECORD_TYPE_MESSAGE_OPTINOUT=254, RECORD_TYPE_MANUAL=255, RECORD_TYPE_WORK_HISTORY_PARSED=301 }

Typenumber
Required
updateType*

The type of update that can activate the webhook.
updateType:
'Insert' |
'Update' |
['Insert', 'Update']{ None=0, Update=1, Insert=2, Delete=4 }

Typenumber
Required
whereClause

Optional where clause to filter when the webhook activates.
Note that internal database fieldnames must be used, so some familiarity with the database structure is required.
whereClause: 'Current_Salary>50000'

Typestring

Responses​

application/json
JSON
{
}

Playground​

Authorization
Variables
Key
Value

Samples​