PayFit Create
CertifiedCreate a PayFit collaborator
PayFit Create
Create a PayFit collaborator
Calls POST /companies/{companyId}/collaborators. The collaborator is created without a contract and does not appear in the PayFit app until a contract is initialized with contracts.Create. Requires the collaborators: write scope. A social security number, when sent, must match the length expected by the company country (FR 15, ES 14, GB 12).
type: io.kestra.plugin.payfit.collaborators.CreateExamples
Initialize a collaborator
id: payfit_create_collaborator
namespace: company.team
tasks:
- id: create
type: io.kestra.plugin.payfit.collaborators.Create
apiKey: "{{ secret('PAYFIT_API_KEY') }}"
firstName: "Ada"
lastName: "Lovelace"
personalEmail: "ada@example.com"
Properties
apiKey *string
API key
PayFit API key or OAuth access token, sent as a bearer token. Create a customer key in the PayFit app under Integrations > API Access, or use the access token returned by auth.AccessToken. Store this value in a Kestra secret.
firstName *string
First name
lastName *string
Last name
personalEmail *string
Personal email address
baseUrl string
https://partner-api.payfit.comPartner API base URL
Base URL of the PayFit Partner API. Defaults to https://partner-api.payfit.com.
birthInformation object
Birth information object accepted by PayFit
body object
Additional JSON fields merged into the request. Explicit task properties override keys in this map
companyId string
Company ID
PayFit company identifier used in /companies/{companyId} paths. When omitted, the task calls POST https://oauth.payfit.com/introspect and uses company_id from the token.
gender string
Gender. Allowed values are MALE and FEMALE
inviteCollaborator booleanstring
Send a PayFit invitation email. Maps to inviteCollaborator. This beta flag defaults to false when omitted
numberOfChildren integerstring
Number of children, from 0 to 20
oauthUrl string
https://oauth.payfit.comOAuth base URL
Base URL used for token introspection and authorization-code exchange. Defaults to https://oauth.payfit.com.
options
HTTP client options
Optional HTTP client configuration applied to PayFit requests.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
otherName string
Additional name, such as a French nom d'usage, a Spanish segundo apellido, or a UK middle name
personalAddress object
Personal address object accepted by PayFit
personalPhoneNumber string
Personal phone number
Outputs
body object
Raw PayFit response
id string
Created collaborator id
