Webhook

Update webhook

Updates the webhook configuration.

post/v1/projects/{project_id}/webhooks/{id}

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/webhooks/{id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Webhook

Request body

urlstring

URL that webhook requests are sent to

secretstring

Secret included with webhook requests for authentication (sent as HTTP basic auth password with username 'telerivet')

eventsstring[]

Array of event types that trigger this webhook. Possible values: send_status (message status updates), send_broadcast (broadcast sent), contact_update (contact added/updated/deleted), message_metadata (message metadata updated)

varsobject

Custom variables stored for this webhook. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

Example request

{
  "url": "https://example.com/webhook",
  "secret": "my-webhook-secret"
}

Response

Successful response

idstring

ID of the webhook

urlstring

URL that webhook requests are sent to

secretstring

Secret included with webhook requests for authentication (sent as HTTP basic auth password with username 'telerivet')

eventsstring[]

Array of event types that trigger this webhook. Possible values: send_status (message status updates), send_broadcast (broadcast sent), contact_update (contact added/updated/deleted), message_metadata (message metadata updated)

varsobject

Custom variables stored for this webhook. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

project_idstring

ID of the project this webhook belongs to

Example response

{
  "id": "WH4f3dac27154653e0",
  "url": "https://example.com/webhook",
  "secret": "my-webhook-secret",
  "project_id": "PJ2ad0100821a98bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.