Webhooks
Create Webhook
Creates a new webhook.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name*string
Human-readable name of the resource.
Length
1 <= lengthactive?boolean
Active value for this resource.
Default
truemethod?"POST" | "PUT" | "PATCH"
Method value for this resource.
Default
"POST"target_url*string
Target URL value for this resource.
Format
uriheaders?|array<>
Headers value for this resource.
Default
{}event*"contact_details.updated" | "contact.created" | "contact.deleted" | "contact.updated" | "conversation.assign" | "conversation.close" | "conversation.inbound" | "conversation.outbound" | "conversation.reopen" | "conversation.sending_error" | "conversation.submission_error" | "conversation.tag" | "conversation.unassign" | "conversation.untag" | "form_submission.aborted" | "form_submission.completed"
Event value for this resource.
fields?array<string>|
Fields value for this resource.
Response Body
application/json
curl -X POST "https://api.getmateo.com/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "target_url": "http://example.com", "event": "contact_details.updated" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "target_url": "string", "event": "contact_details.updated", "method": "GET", "active": true, "headers": { "property1": null, "property2": null }, "fields": [ "string" ], "api_version": "legacy", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}