--- title: "interviewScheduleCreate" method: POST path: "interviewScheduleCreate" tags: ["Webhook Payloads"] --- # interviewScheduleCreate `POST interviewScheduleCreate` (webhook) The webhook is called when an interview schedule is created. Also triggers [interviewScheduleUpdate](https://developers.ashbyhq.com/reference/interviewscheduleupdatewebhook) ## Payload - object - `action` 'interviewScheduleCreate', required - `data` object, required - `interviewSchedule` OverlayInterviewSchedule - `id` string, required — The id of the interview schedule - `status` 'NeedsScheduling' | 'WaitingOnCandidateBooking' | 'WaitingOnCandidateAvailability' | 'CandidateAvailabilitySubmitted' | 'Scheduled' | 'WaitingOnFeedback' | 'Complete' | 'Cancelled' | 'OnHold' | 'Unknown', required — The status of the interview schedule - `applicationId` string, required — The id of the application associated with the interview schedule - `interviewStageId` string, required — The id of the interview stage associated with the interview schedule - `scheduledBy` OverlayUser - `id` string, uuid, required - `firstName` string, required - `lastName` string, required - `email` string - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required - `isEnabled` boolean, required - `updatedAt` string, date-time, required - `managerId` string, uuid - `customFields` OverlayCustomField[] — Custom field values associated with the user. **Note:** This field requires a feature to be enabled for your organization. If it is not present in the response, please contact Ashby support to have it enabled. - `id` string, uuid, required - `isPrivate` boolean - `title` string, required - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - string - string[] - `value` union, required - boolean - object - … - string, date-time - string - string - string[] - number - object - … - object - … - string - `createdAt` string, date-time — The time the interview schedule was created - `updatedAt` string, date-time — The time the interview schedule was last updated - `interviewEvents` OverlayInterviewEvent[] — All scheduled interview events associated with the interview schedule - `id` string, uuid, required — The interview event's id - `interviewId` string, uuid, required — The interview's id - `interviewScheduleId` string, uuid, required — The interview schedule's id - `interviewerUserIds` string[] — An array of the ids of all interviewers. Use the `interviewers` field instead for more detailed information. - `interviewers` OverlayInterviewerWithPoolUser[], required — An array of user objects representing the interviewers on this event, including their training role and pool information. - `id` string, uuid, required - `firstName` string, required - `lastName` string, required - `email` string - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required - `isEnabled` boolean, required - `updatedAt` string, date-time, required - `managerId` string, uuid - `customFields` OverlayCustomField[] — Custom field values associated with the user. **Note:** This field requires a feature to be enabled for your organization. If it is not present in the response, please contact Ashby support to have it enabled. - `id` string, uuid, required - `isPrivate` boolean - `title` string, required - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - … - `value` union, required - … - `trainingRole` 'Shadow' | 'Reverse-Shadow', nullable, required — The training-related role of the interviewer for this specific event. Returns null when the interviewer is qualified for interviewing (or Interviewer Training is not enabled). See [Ashby Knowledge Base](https://docs.ashbyhq.com/interviewer-training) for more information. - `interviewerPool` OverlayInterviewerPoolBrief, required - `id` string, uuid, required — The pool's id - `title` string, required — The pool's title - `isArchived` boolean, required — Whether or not the pool is archived - `trainingPath` OverlayInterviewerPoolTrainingPath - … - `isFeedbackRequired` boolean, required — Whether feedback is required from this interviewer for this specific event. - `createdAt` string, date-time, required — The time the interview event was created - `updatedAt` string, date-time, required — The time the interview event was last updated - `startTime` string, date-time, required — The time the interview event is scheduled to start - `endTime` string, date-time, required — The time the interview event is scheduled to end - `feedbackLink` string, uri, required — The link to submit feedback for the interview event - `location` string, nullable — The location of the interview - `meetingLink` string, uri, nullable — A link to the virtual meeting (if the interview is being hosted virtually) - `interviewerCalendarEventId` string, nullable — The external calendar event id for the interviewer's calendar event - `hasSubmittedFeedback` boolean, required — Whether or not this interview has any feedback submitted - `interview` OverlayInterview - `id` string, uuid, required — The interview's id - `title` string, required — The interview's title - `externalTitle` string — Alternate candidate-facing interview title displayed in email/interview communications. If not specified, the primary title will be returned. - `isArchived` boolean, required — Whether or not the interview is archived - `isDebrief` boolean — Whether the interview is a debrief - `isFeedbackRequired` boolean, required — Whether feedback is required by default for interviewers assigned to this interview - `isFeedbackRequested` boolean, required — Whether feedback is requested by default for interviewers assigned to this interview - `instructionsHtml` string — An HTML version of the interview's description - `instructionsPlain` string — A plaintext version of the interview's description - `jobId` string, uuid — The id of the job the interview is associated with. If null, the interview is not associated with a specific job and is a shared interview. Interviews that are associated with particular jobs can only be scheduled for applications to those jobs. - `feedbackFormDefinitionId` string, uuid, required — The id of the feedback form definition associated with the interview. - `notetakerTranscriptId` string, uuid, nullable — The id of the AI notetaker transcript recording for this interview event, if one exists. Use with the notetakerTranscript.info endpoint to fetch transcript metadata and a download URL. This feature is in Beta. Contact us to enable transcript API access for your organization. - `extraData` ExtraData — This field stores information, structured as key-value pairs, for your own use and reference, for example a unique identifier for your own system. Do not store personally identifiable information (PII) in this field. In addition, the following constraints apply: - Keys must be strings of at most 100 characters. - Values must be strings of at most 512 characters. - The total size of the extra data must be less than 1kb. We recommend using a prefix for your keys to avoid collisions with other systems, as data stored in this field is available to all API users with permission to access the underlying object. ## Acknowledgement `200` Return a 200 status to indicate that the data was received successfully --- [API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)