Developers & API Docs

Webhook Delivery Rules

YouSquared will send HTTP POST requests to your webhook endpoint to notify you of eventsin real time. You must implement an HTTPS endpoint that accepts these POST requests.

When you register your webhook with YouSquared, you must provide a secret. This secret is securely stored and encrypted by YouSquared.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Each webhook request from YouSquared will include this secret in the Authorization: Bearer <secret> header. You should verify this secret to ensure the request is from YouSquared.

The response body is ignored by YouSquared.

YouSquared does not retry
or process non-2xx responses.

This documentation describes the payloads you will receive.

Webhook Endpoint

YouSquared will POST event notifications to this endpoint. You must implement this endpoint to receive and process event data. Each request will include an Authorization:Bearer <secret> header for authentication.

Authorizations

bearerAuth

Request Body schema: application/json

required

application/json

required

string

Enum "contact_updated" "form_opened" "form_sent" "form_signed" "form_submitted" "inbound_end_of_call"

Type of event being sent

payload

required

ContactUpdatedPayload (object) or
FormOpenedPayload (object) or
FormSentPayload (object) or
FormSubmittedPayload (object) or
FormSignedPayload (object) or
InboundEndOfCallPayload (object)

Post

/your/webhook/endpoint

Request samples
Playload
Content type

application/json

{    

    "event_type": "contact_updated",

    "payload": {      

"phone_number": "string",

"first_name":"string",

"last_name": "string"    

    }

}

Responses

-400

For reliable delivery, ensure your endpoint maintains high availability. Contact us if you need delivery logs or debugging support.

-2XX

Acknowledge receipt of the event. YouSquared does not process the response body.