Introduction

Introduction
- Entities
Conventions

Gupy Public API

Applications
Company Career Pages
- Listing career pagesget
Company Departments
Job Custom Fields
- Listing custom fields of a company for job creationget
Job Templates
- Listing custom-fields of a job templateget
- Listing jobs templatesget
Jobs
Job Roles
Talent Recommendations
- Approve talent recommendationpost
- Reject talent recommendationpost
Company Users
Company Branches
Post Hiring
E-mail templates
- Listing e-mail templatesget
Company Employee
Webhook Configurations

Webhooks - recrutamento & seleção

About Gupy webhooks
Application Assigned event
Application Created event
Application Completed event
Application Moved event
Candidate Hired event
Job New Recommendation
Job Published
Job Status Changed
Job Changed

Webhooks - admissão

Pre-Employee Moved event
Pre-Employee Admission Concluded event
Admission Automatic Routing Process Created event
Admission Automatic Routing Objection Created event

API - GUPY ADMISSÃO

Tokens
- Creating an api tokenpost
Contracts
- Creating an contractpost
PreEmployees
- Searching for pre employees by filterget
- Creating a PreEmployeepost
WorkflowSteps
- Change current pre employee workflow steppatch
- Listing workflow stepsget
CustomFields
Benefits
- Update routes to requested automatic routing processpatch
- Update automatic routing objectionpatch

API - Gupy Educação Corporativa

Convenções
Usuário
Grupo

API - Gupy Clima e Engajamento

Groups
Employees
Instruments
- Get all instrumentsget
- Consulta dados do instrumento via uid_instrumentget
Score

Trilhas API

Convenções
Settings
- Cria um token na central de empresas da Gupypost
Pathways
Employees
Contents

Listing webhook configurations

get https://api.gupy.io/api/v1/webhooks

Returns a list of webhooks.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Query Params

fields

string

Specify fields to return (eg. fields=id,action or fields=all).
Default: id, action, postbackUrl

perPage

int64

Defaults to 10

Pagination: How many items per page

page

int64

Defaults to 1

Pagination: Which page to query

Responses

Response body

object

results

array of objects

required

results*

object

string

required

length ≤ 255

Webhook ID

action

string

required

length ≤ 255

Webhook action to watch

application.created application.completed application.moved application.assigned candidate.hired job.changed job.new-recommendation job.published job.status-changed pre-employee.moved pre-employee.admission-concluded admission.automatic-routing-process admission.automatic-routing-objection

status

string

length ≤ 255

Subscription status (defaults to active).

active inactive

techOwnerName

string

length ≤ 255

Technical responsible for the subscription

techOwnerEmail

string

length ≤ 255

Email of the technical responsible

postbackUrl

string

required

length ≤ 2048

Url to be called when webhook is fired

clientHeaders

object

Headers to be included on the request ({ "myCustomHeader": "myExpectedValue "})

Has additional fields

totalResults

int64

page

int64

totalPages

int64

Response body

object

title

string

length ≤ 255

A short, human-readable summary of the problem type

detail

string

length ≤ 255

A human-readable explanation specific to this occurrence of the problem

status

int32

The HTTP status code generated for this occurrence of the problem

Headers

object

X-RateLimit-Limit

integer

Request limit per hour.

X-RateLimit-Remaining

integer

The number of requests left for the time window.

X-RateLimit-Reset

integer

The UTC timestamp at which the current rate limit window resets

Response body

object

title

string

length ≤ 255

A short, human-readable summary of the problem type

detail

string

length ≤ 255

A human-readable explanation specific to this occurrence of the problem

status

int32

The HTTP status code generated for this occurrence of the problem

Headers

object

X-RateLimit-Limit

integer

Request limit per hour.

X-RateLimit-Remaining

integer

The number of requests left for the time window.

X-RateLimit-Reset

integer

The UTC timestamp at which the current rate limit window resets

Response body

object

title

string

length ≤ 255

A short, human-readable summary of the problem type

detail

string

length ≤ 255

A human-readable explanation specific to this occurrence of the problem

status

int32

The HTTP status code generated for this occurrence of the problem

Headers

object

X-RateLimit-Limit

integer

Request limit per hour.

X-RateLimit-Remaining

integer

The number of requests left for the time window.

X-RateLimit-Reset

integer

The UTC timestamp at which the current rate limit window resets

Updated 10 days ago

Configuring webhooks

Deleting webhook configurations

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.gupy.io/api/v1/webhooks?perPage=10&page=1' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 10 days ago

Configuring webhooks

Deleting webhook configurations

Did this page help you?

Introduction
Introduction
Entities
Conventions
Rate-Limiting
Operations
Response fields
Response status codes and errors
Response Format
Pagination
Authentication

Gupy Public API
Applications
Creating and sending an email message to a candidatepost
Listing comments in candidate timelineget
Creating a comment in candidate timelinepost
Deleting an application tagdelete
Retrieving an application's rating criteriaget
Find hiring informationget
Update hiring informationpatch
Listing application tagsget
Deleting an application tag by tag valuedelete
Adding tags to applicationput
Inviting the candidatepost
Moving an applicationpatch
Creating an applicationpost
Listing applicationsget
Company Career Pages
Listing career pagesget
Company Departments
Updating a departmentput
Creating a departmentpost
Listing departmentsget
Job Custom Fields
Listing custom fields of a company for job creationget
Job Templates
Listing jobs templatesget
Listing custom-fields of a job templateget
Jobs
Updating a vacancy codeput
Deleting a vacancy codedelete
Listing vacancy codesget
Creating a vacancy codepost
List job classifiersget
Create a classifierpost
Close jobsput
Deleting a draft jobdelete
Updating a jobpatch
Listing steps of a jobget
Listing custom fields of a jobget
Listing jobsget
Creating a jobpost
Job Roles
Updating a roleput
Creating a rolepost
Listing rolesget
Talent Recommendations
Reject talent recommendationpost
Approve talent recommendationpost
Company Users
Inviting an userpost
Deleting an userdelete
Updating an userput
Listing usersget
Creating an userpost
Listing user access profilesget
Company Branches
Updating branchesput
Deleting a branchdelete
Listing branchesget
Creating branchespost
Post Hiring
Updating performance evaluationput
Listing performance evaluationsget
Creating a performance evaluationpost
Updating dismissalsput
Listing dismissalsget
Creating a dismissalpost
E-mail templates
Listing e-mail templatesget
Company Employee
Update Company employeeput
Deletes a company employeedelete
Get a list of company employeesget
Create a list of company employeespost
Webhook Configurations
Updating webhook configurationsput
Deleting webhook configurationsdelete
Listing webhook configurationsget
Configuring webhookspost

Webhooks - recrutamento & seleção
About Gupy webhooks
Application Assigned event
Application Created event
Application Completed event
Application Moved event
Candidate Hired event
Job New Recommendation
Job Published
Job Status Changed
Job Changed

Webhooks - admissão
Pre-Employee Moved event
Pre-Employee Admission Concluded event
Admission Automatic Routing Process Created event
Admission Automatic Routing Objection Created event

API - GUPY ADMISSÃO
Tokens
Creating an api tokenpost
Contracts
Creating an contractpost
PreEmployees
Creating a PreEmployeepost
Searching for pre employees by filterget
WorkflowSteps
Listing workflow stepsget
Change current pre employee workflow steppatch
CustomFields
Delete a custom field already createddelete
Update a custom field already createdpatch
Create a new custom fieldpost
Get custom fields with paginationget
Benefits
Update automatic routing objectionpatch
Update routes to requested automatic routing processpatch

API - Gupy Educação Corporativa
Convenções
Usuário
Excluir Usuáriodelete
Detalhar Usuáriosget
Cadastrar/Atualizar Usuáriospost
Listar Usuáriosget
Grupo
Listar Grupos de um Usuárioget
Excluir Grupodelete
Atualizar Grupoput
Detalhar Grupoget
Excluir Membro do Grupodelete
Detalhar Membro de um Grupoget
Adicionar Membro a um Grupopost
Listar Membros de um Grupoget
Cadastrar Grupopost
Listar Gruposget

API - Gupy Clima e Engajamento
Groups
Delete a groupdelete
Update a groupput
Get group by id_groupget
Find groups by nameget
Get all groups in tree list formatget
Create a grouppost
Get all groups in alphabetical list formatget
Employees
Delete a employee from groupdelete
Add a employee to grouppost
Delete a employeedelete
Update a employeeput
Get an employee by id_personget
Create a employeepost
Get all employeesget
Instruments
Consulta dados do instrumento via uid_instrumentget
Get all instrumentsget
Score
Consumo dos scores agregadoget
Consumo dos scores de pesquisas parcialmente anônimas e identificadasget
Consumo dos scores previamente processadosget
Consulta Pública da Caixa de Sugestõespost
Consulta das sugestões enviadas pelo suggestion boxget
Consulta dos feedbacks dos instrumentospost
Exporta o score com cruzamentospost

Trilhas API
Convenções
Settings
Cria um token na central de empresas da Gupypost
Pathways
Buscar grupos de uma trilha específicaget
Buscar uma trilha específicaget
Buscar trilhas da empresaget
Employees
Buscar detalhes da trilha que o colaborador faz parteget
Buscar trilhas que o colaborador faz parteget
Buscar grupos que o colaborador faz parteget
Buscar colaboradores da empresaget
Contents
Lista os colaboradores que acessaram o conteúdo, incluindo as trilhas associadasget
Obtém um conteúdo disponibilizado em trilhaget
Buscar conteúdos disponibilizados em trilhasget

200An array of webhooks

400BadRequest / Invalid Input

401Unauthorized

403Forbidden