Create a webhook

post

https://vision-api.truepic.{tld}/v3/webhooks

Body Params

custom_headers

An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of "{{ UUID }}". When the webhook is sent, this will be replaced with a unique UUID for each request.

is_disabled

boolean

Whether or not the webhook should be disabled. If set to true, the webhook will be disabled and no longer send POST requests. If set to false, the webhook will be enabled and will send POST requests. If you omit this field, the webhook will not change its disabled state.

mutual_tls

boolean

Defaults to false

Whether or not to use Mutual TLS when sending the webhook POST request. This is an additional security measure that requires the receiving service to present a valid TLS certificate and to verify our API server's certificate before accepting the request.

secret

string | null

The secret used for authenticating the webhooks. When we send webhooks to your endpoint, we will add a truepic-signature header to those requests that we generate using this secret. When your endpoint receives a webhook POST request, you can then verify that the request was signed with this secret to ensure that the request is from us. If you want to remove the secret, set this to null. If you want to set a new secret, provide the new secret string. If you don't want to change the secret, omit this field.

team_id

number

required

The id of the team. Each team can have only one webhook.

url

required

The url that the webhook POST request is sent to.

vision_api_version

string

enum

Defaults to v3

The API version used to send the webhook POST request. Determines the terminology (v2 or v3) sent.

Allowed:

Responses

200Success

400The request body couldn't be parsed.

401Authentication failed, or the user/client doesn't have permission to the requested resource.

403The user doesn't have permission to access the requested resource.

404The requested resource couldn't be found.

412A required property or parameter is missing from the request.

500An unexpected error occurred.